v1

Documentation

Index

• func DemoGet(c *gin.Context)
• func DemoPost(c *gin.Context)
• func SystemInfo(c *gin.Context)
• func TestLog(c *gin.Context)
• func UserLogin(c *gin.Context)
• func UserLogout(c *gin.Context)
• func UserRegister(c *gin.Context)
• type LoginForm
• type Params
• type RegisterForm

Functions

func DemoGet

func DemoGet(c *gin.Context)

DemoGet @Summary demo，测试get @Produce json @Tags Demo/Test @Param param1 query string false "some params named param1" @Param param2 query string false "some params named param2" @Success 200 {string} json "" @Router /v1/demo/get [get] @Security ApiKeyAuth

func DemoPost

func DemoPost(c *gin.Context)

DemoPost @Summary demo，测试post @Produce json @Tags demo @Param params body Params false "some params json" @Success 200 {string} json "" @Router /v1/demo/post [post] @Security ApiKeyAuth

func SystemInfo

func SystemInfo(c *gin.Context)

SystemInfo @Summary System Info @Tags System @Success 200 {object} app.ApiJson "" @Router /v1/system/info [get] @Security ApiKeyAuth

func TestLog

func TestLog(c *gin.Context)

TestLog @Summary demo，测试post @Produce json @Tags demo @Success 200 {string} json "" @Router /v1/test/test-log [get] @Security ApiKeyAuth

func UserLogin

func UserLogin(c *gin.Context)

UserLogin @Summary User login @Tags User @Param form body LoginForm true "register form" @Success 200 {object} app.ApiJson "" @Failure 400 {object} app.ErrJson "" @Router /v1/user/login [post]

func UserLogout

func UserLogout(c *gin.Context)

UserLogout @Summary User logout @Tags User @Success 200 {object} app.ApiJson "" @Failure 400 {object} app.ErrJson "" @Router /v1/user/logout [post] @Security ApiKeyAuth

func UserRegister

func UserRegister(c *gin.Context)

UserRegister @Summary User register @Tags User @Param form body RegisterForm true "register form" @Success 200 {object} app.ApiJson "" @Failure 400 {object} app.ErrJson "" @Router /v1/user/register [post]

Types

type LoginForm

type LoginForm struct {
	UserId   int64
	Password string
}

type Params

type Params struct {
	Param1 string `json:"param1"`
	Param2 string `json:"param2"`
}

type RegisterForm

type RegisterForm struct {
	UserName string  `binding:"alphanum"`
	Email    *string `binding:"email"`
	Phone    *string `binding:"e164"`
	Password string
}