controllers

Documentation

Index

• type AuthPublicController
  • func (apc *AuthPublicController) Login(c *gin.Context)
  • func (c *AuthPublicController) Prepare()
  • func (apc *AuthPublicController) Register(c *gin.Context)
• type Controllers
  • func (c *Controllers) ReturnNotOK(ctx *gin.Context, err error)
  • func (c *Controllers) ReturnOK(ctx *gin.Context, httpStatus int, message string, object interface{})
• type UserPublicController
  • func (upc *UserPublicController) GetUser(c *gin.Context)
  • func (c *UserPublicController) Prepare()

Types

type AuthPublicController

type AuthPublicController struct {
	Controllers
	// contains filtered or unexported fields
}

func (*AuthPublicController) Login

func (apc *AuthPublicController) Login(c *gin.Context)

Login godoc @Summary Login @Description Login user to our system account. @Tags authentication @Accept json @Param credential body schemas.Login true "user credential" @Produce json @Success 200 {object} schemas.GeneralResponse @Router /v1/public/auth/login [post]

func (*AuthPublicController) Prepare

func (c *AuthPublicController) Prepare()

func (*AuthPublicController) Register

func (apc *AuthPublicController) Register(c *gin.Context)

Register godoc @Summary Register @Description Register user to our system account. @Tags authentication @Accept json @Param registrationData body schemas.Register true "user registration data" @Produce json @Success 201 {object} schemas.GeneralResponse @Router /v1/public/auth/register [post]

type Controllers

type Controllers struct{}

func (*Controllers) ReturnNotOK

func (c *Controllers) ReturnNotOK(ctx *gin.Context, err error)

func (*Controllers) ReturnOK

func (c *Controllers) ReturnOK(ctx *gin.Context, httpStatus int, message string, object interface{})

type UserPublicController

type UserPublicController struct {
	Controllers
	// contains filtered or unexported fields
}

func (*UserPublicController) GetUser

func (upc *UserPublicController) GetUser(c *gin.Context)

GetUser godoc @Summary Get One User @Description Returns the user who matches the username. @Tags users @Produce json @Success 200 {object} models.User @Router /v1/public/users/{username} [get]

func (*UserPublicController) Prepare

func (c *UserPublicController) Prepare()