controllers

Documentation

Index

• type ExampleController
  • func (exampleController *ExampleController) CreateExample(ctx *gin.Context)
  • func (exampleController *ExampleController) DeleteExample(ctx *gin.Context)
  • func (exampleController *ExampleController) GetExample(ctx *gin.Context)
  • func (exampleController *ExampleController) UpdateExample(ctx *gin.Context)
• type LoginByUsernamePasswordRequest
• type PublicController
  • func (publicController *PublicController) Ping(ctx *gin.Context)
• type UserController
  • func (userController *UserController) LoginByUsernamePassword(ctx *gin.Context)

Types

type ExampleController

type ExampleController struct{}

func (*ExampleController) CreateExample

func (exampleController *ExampleController) CreateExample(ctx *gin.Context)

@Router /examples/createExample [post] @Description Create Example @Tags Example @Param data body string true "data" @Success 200 {object} object @Security BearerAuth

func (*ExampleController) DeleteExample

func (exampleController *ExampleController) DeleteExample(ctx *gin.Context)

@Router /examples/deleteExample [post] @Description Delete Example @Tags Example @Param data body string true "data" @Success 200 {object} object @Security BearerAuth

func (*ExampleController) GetExample

func (exampleController *ExampleController) GetExample(ctx *gin.Context)

@Router /examples/getExample [get] @Description Get Example @Tags Example @Param exampleId query int true "the example id" 22 @Success 200 {object} object @Security BearerAuth

func (*ExampleController) UpdateExample

func (exampleController *ExampleController) UpdateExample(ctx *gin.Context)

@Router /examples/updateExample [post] @Description Update Example @Tags Example @Param data body string true "data" @Success 200 {object} object @Security BearerAuth

type LoginByUsernamePasswordRequest

type LoginByUsernamePasswordRequest struct {
	Usernmae string `json:"username" default:"admin"`
	Password string `json:"password" default:"123456"`
}

type PublicController

type PublicController struct{}

func (*PublicController) Ping

func (publicController *PublicController) Ping(ctx *gin.Context)

@Router /public/ping [get] @Description Ping @Tags Public @Success 200 {object} string

type UserController

type UserController struct{}

func (*UserController) LoginByUsernamePassword

func (userController *UserController) LoginByUsernamePassword(ctx *gin.Context)

@Router /users/loginByUsernamePassword [post] @Description Login By Username Password @Tags User @Param data body LoginByUsernamePasswordRequest true "username、password"