PopCube API

This repository contain the GO API for PopCube projet

Aims

Popcube api is a simple api to manage database communication for the chat project PopCube. It contains data models and methods to manage the database. The api in itself provide basics methods we are using to manage data.

How to use

By go get

To use this project, you can just make a go get github.com/titouanfreville/popcubeapi

From source

From source, you just have to clone the project, then run godep get to install all the dependencies.

Routes

`/`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /
  • GET
    • basicRoutes.func1

`/avatar`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllAvatar
    • POST
      • newAvatar

`/avatar/:avatarID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:avatarID
    • avatarContext
    • /delete
      • DELETE
        • deleteAvatar

`/avatar/:avatarID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:avatarID
    • avatarContext
    • /update
      • PUT
        • updateAvatar

`/avatar/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllAvatar

`/avatar/link/:avatarLink`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /link
    • /:avatarLink
      • avatarContext
      • /
        • GET
          • getAvatarFromLink

`/avatar/name/:avatarName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /name
    • /:avatarName
      • avatarContext
      • /
        • GET
          • getAvatarFromName

`/avatar/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /avatar
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newAvatar

`/channel`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllChannel
    • POST
      • newChannel

`/channel/:channelID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:channelID
    • channelContext
    • /delete
      • DELETE
        • deleteChannel

`/channel/:channelID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:channelID
    • channelContext
    • /update
      • PUT
        • updateChannel

`/channel/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllChannel

`/channel/name/:channelName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /name
    • /:channelName
      • channelContext
      • /
        • GET
          • getChannelFromName

`/channel/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newChannel

`/channel/private`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /private
    • GET
      • getPrivateChannel

`/channel/public`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /public
    • GET
      • getPublicChannel

`/channel/type/:channelType`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /channel
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /type
    • /:channelType
      • channelContext
      • /
        • GET
          • getChannelFromType

`/emoji`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllEmoji
    • POST
      • newEmoji

`/emoji/:emojiID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:emojiID
    • emojiContext
    • /delete
      • DELETE
        • deleteEmoji

`/emoji/:emojiID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:emojiID
    • emojiContext
    • /update
      • PUT
        • updateEmoji

`/emoji/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllEmoji

`/emoji/link/:emojiLink`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /link
    • /:emojiLink
      • emojiContext
      • /
        • GET
          • getEmojiFromLink

`/emoji/name/:emojiName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /name
    • /:emojiName
      • emojiContext
      • /
        • GET
          • getEmojiFromName

`/emoji/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newEmoji

`/emoji/shortcut/:emojiShortcut`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /emoji
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /shortcut
    • /:emojiShortcut
      • emojiContext
      • /
        • GET
          • getEmojiFromShortcut

`/folder`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllFolder
    • POST
      • newFolder

`/folder/:folderID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:folderID
    • folderContext
    • /delete
      • DELETE
        • deleteFolder

`/folder/:folderID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:folderID
    • folderContext
    • /update
      • PUT
        • updateFolder

`/folder/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllFolder

`/folder/link/:folderLink`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /link
    • /:folderLink
      • folderContext
      • /
        • GET
          • getFolderFromLink

`/folder/message`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /message
    • POST
      • getFolderFromMessage

`/folder/name/:folderName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /name
    • /:folderName
      • folderContext
      • /
        • GET
          • getFolderFromName

`/folder/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newFolder

`/folder/type/:folderType`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /folder
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /type
    • /:folderType
      • folderContext
      • /
        • GET
          • getFolderFromType

`/heartbeat`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /heartbeat
  • GET
    • basicRoutes.func3

`/login`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /login
  • POST
    • loginMiddleware

`/message`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllMessage
    • POST
      • newMessage

`/message/:messageID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:messageID
    • messageContext
    • /delete
      • DELETE
        • deleteMessageFunction

`/message/:messageID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:messageID
    • messageContext
    • /update
      • PUT
        • updateMessage

`/message/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllMessage

`/message/channel`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /channel
    • POST
      • getMessageFromChannel

`/message/creator`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /creator
    • POST
      • getMessageFromUser

`/message/date/:messageDate`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /date
    • /:messageDate
      • messageContext
      • /
        • GET
          • getMessageFromDate

`/message/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /message
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newMessage

`/organisation`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /organisation
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllOrganisation
    • POST
      • newOrganisation

`/organisation/:organisationID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /organisation
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:organisationID
    • organisationContext
    • /update
      • PUT
        • updateOrganisation

`/organisation/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /organisation
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllOrganisation

`/organisation/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /organisation
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newOrganisation

`/panic`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /panic
  • GET
    • basicRoutes.func4

`/parameter`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /parameter
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • POST
      • newParameter
    • GET
      • getAllParameter

`/parameter/:parameterID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /parameter
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:parameterID
    • parameterContext
    • /update
      • PUT
        • updateParameter

`/parameter/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /parameter
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllParameter

`/parameter/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /parameter
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newParameter

`/ping`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /ping
  • GET
    • basicRoutes.func2

`/role`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • POST
      • newRole
    • GET
      • getAllRole

`/role/:roleID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:roleID
    • roleContext
    • /delete
      • DELETE
        • deleteRole

`/role/:roleID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:roleID
    • roleContext
    • /update
      • PUT
        • updateRole

`/role/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllRole

`/role/name/:roleName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /name
    • /:roleName
      • roleContext
      • /
        • GET
          • getRoleFromName

`/role/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newRole

`/role/rights`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /role
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /rights
    • POST
      • getRoleFromRight

`/user`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /
    • GET
      • getAllUser
    • POST
      • newUser

`/user/:userID/delete`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:userID
    • userContext
    • /delete
      • DELETE
        • deleteUser

`/user/:userID/update`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /:userID
    • userContext
    • /update
      • PUT
        • updateUser

`/user/all`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /all
    • GET
      • getAllUser

`/user/date`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /date
    • GET
      • getOrderedByDate

`/user/deleted`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /deleted
    • GET
      • getDeletedUser

`/user/email/:userEmail`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /email
    • /:userEmail
      • userContext
      • /
        • GET
          • getUserFromEmail

`/user/firstname/:firstName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /firstname
    • /:firstName
      • userContext
      • /
        • GET
          • getUserFromFirstName

`/user/lastname/:lastName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /lastname
    • /:lastName
      • userContext
      • /
        • GET
          • getUserFromLastName

`/user/new`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /new
    • POST
      • newUser

`/user/nickname/:nickName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /nickname
    • /:nickName
      • userContext
      • /
        • GET
          • getUserFromNickName

`/user/role`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /role
    • POST
      • getUserFromRole

`/user/username/:userName`

• RequestID
• RealIP
• Logger
• Recoverer
• StripSlashes
• Timeout.func1
• Heartbeat.func1
• CloseNotify
• /user
  • github.com/goware/jwtauth.(*JwtAuth).Verifier-fm
  • Authenticator
  • /username
    • /:userName
      • userContext
      • /
        • GET
          • getUserFromName

Models

Avatar

The avatar model is used to store Avatar locations and names.

Structure

Row	Type	Parameters	Database Column	JSON Key
IDAvatar	uint64	primary key, autoincrement	idAvatar	UNDEFINED
Name	string	not null, unique	name	name
Link	string	not null, unique	link	link

Functions

IsValid

IsValid is a function to check the integrity of the provided avatar before sending it to the database. It will ensure that the link is not empty as well as the name.

Usage: avatar.IsValid()

ToJSON

ToJSON is a function to convert the Go Avatar struct in JSON object.

Usage: avatar.ToJSON()

AvatarFromJSON

AvatarFromJSON is a function who will try to parse a JSON object as Go Avatar struct.

Usage: AvatarFromJSON(strings.NewReader(json))

AvatarListToJSON

AvatarListToJSON is a function to convert the Go Avatar struct slice in JSON object.

Usage: AvatarListToJSON(avatarList)

AvatarListFromJSON

AvatarListFromJSON is a function who will try to parse a JSON object as Go Avatar struct slice.

Usage: AvatarListFromJSON(strings.NewReader(json))