mock

Documentation

Index

• Variables
• type HealthCheck
  • func (a *HealthCheck) Get(c *gin.Context)
• type Login
  • func (a *Login) GetCaptcha(c *gin.Context)
  • func (a *Login) GetUserInfo(c *gin.Context)
  • func (a *Login) Login(c *gin.Context)
  • func (a *Login) Logout(c *gin.Context)
  • func (a *Login) QueryUserMenuTree(c *gin.Context)
  • func (a *Login) RefreshToken(c *gin.Context)
  • func (a *Login) ResCaptcha(c *gin.Context)
  • func (a *Login) UpdatePassword(c *gin.Context)
• type Menu
  • func (a *Menu) Create(c *gin.Context)
  • func (a *Menu) Delete(c *gin.Context)
  • func (a *Menu) Disable(c *gin.Context)
  • func (a *Menu) Enable(c *gin.Context)
  • func (a *Menu) Get(c *gin.Context)
  • func (a *Menu) Query(c *gin.Context)
  • func (a *Menu) QueryTree(c *gin.Context)
  • func (a *Menu) Update(c *gin.Context)
• type Role
  • func (a *Role) Create(c *gin.Context)
  • func (a *Role) Delete(c *gin.Context)
  • func (a *Role) Disable(c *gin.Context)
  • func (a *Role) Enable(c *gin.Context)
  • func (a *Role) Get(c *gin.Context)
  • func (a *Role) Query(c *gin.Context)
  • func (a *Role) QuerySelect(c *gin.Context)
  • func (a *Role) Update(c *gin.Context)
• type User
  • func (a *User) Create(c *gin.Context)
  • func (a *User) Delete(c *gin.Context)
  • func (a *User) Disable(c *gin.Context)
  • func (a *User) Enable(c *gin.Context)
  • func (a *User) Get(c *gin.Context)
  • func (a *User) Query(c *gin.Context)
  • func (a *User) Update(c *gin.Context)

Variables

var HealthCheckSet = wire.NewSet(wire.Struct(new(HealthCheck), "*"))

var LoginSet = wire.NewSet(wire.Struct(new(Login), "*"))

var MenuSet = wire.NewSet(wire.Struct(new(Menu), "*"))

var MockSet = wire.NewSet(
	LoginSet,
	MenuSet,
	RoleSet,
	UserSet,
)

var RoleSet = wire.NewSet(wire.Struct(new(Role), "*"))

var UserSet = wire.NewSet(wire.Struct(new(User), "*"))

Types

type HealthCheck

type HealthCheck struct {
}

func (*HealthCheck) Get

func (a *HealthCheck) Get(c *gin.Context)

Get HealthCheck @Tags HealthCheck @Summary HealthCheck @Success 200 {object} response.HealthCheck @Router /api/health [get]

type Login

type Login struct {
}

func (*Login) GetCaptcha

func (a *Login) GetCaptcha(c *gin.Context)

GetCaptcha Get Captcha @Tags Login @Summary Get Captcha @Success 200 {object} response.LoginCaptcha @Router /api/v1/pub/login/captchaid [get]

func (*Login) GetUserInfo

func (a *Login) GetUserInfo(c *gin.Context)

GetUserInfo Get current user info @Tags Login @Summary Get current user info @Security ApiKeyAuth @Success 200 {object} response.UserLoginInfo @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/current/user [get]

func (*Login) Login

func (a *Login) Login(c *gin.Context)

Login Login @Tags Login @Summary Login @Param body body request.LoginParam true "Request parameters" @Success 200 {object} response.LoginTokenInfo @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/login [post]

func (*Login) Logout

func (a *Login) Logout(c *gin.Context)

Logout Logout @Tags Login @Summary Logout @Success 200 {object} response.StatusResult "{status:OK}" @Router /api/v1/pub/login/exit [post]

func (*Login) QueryUserMenuTree

func (a *Login) QueryUserMenuTree(c *gin.Context)

QueryUserMenuTree Get user menu tree @Tags Login @Summary Get user menu tree @Security ApiKeyAuth @Success 200 {object} response.ListResult{list=[]response.MenuTree} "Search Result" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/current/menutree [get]

func (*Login) RefreshToken

func (a *Login) RefreshToken(c *gin.Context)

RefreshToken Refresh token @Tags Login @Summary Refresh token @Security ApiKeyAuth @Success 200 {object} response.LoginTokenInfo @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/refresh-token [post]

func (*Login) ResCaptcha

func (a *Login) ResCaptcha(c *gin.Context)

ResCaptcha Response captcha @Tags Login @Summary Response captcha @Param id query string true "Captcha ID" @Param reload query string false "Reload" @Produce image/png @Success 200 "ResCaptcha" @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/login/captcha [get]

func (*Login) UpdatePassword

func (a *Login) UpdatePassword(c *gin.Context)

UpdatePassword Update password @Tags Login @Summary Update password @Security ApiKeyAuth @Param body body request.UpdatePasswordParam true "Request parameters" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/pub/current/password [put]

type Menu

type Menu struct{}

func (*Menu) Create

func (a *Menu) Create(c *gin.Context)

Create Create @Tags Menu @Summary Create @Security ApiKeyAuth @Param body body request.Menu true "Create" @Success 200 {object} response.IDResult @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus [post]

func (*Menu) Delete

func (a *Menu) Delete(c *gin.Context)

Delete Delete @Tags Menu @Summary Delete @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus/{id} [delete]

func (*Menu) Disable

func (a *Menu) Disable(c *gin.Context)

Disable Disable @Tags Menu @Summary Disable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus/{id}/disable [patch]

func (*Menu) Enable

func (a *Menu) Enable(c *gin.Context)

Enable Enable @Tags Menu @Summary Enable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus/{id}/enable [patch]

func (*Menu) Get

func (a *Menu) Get(c *gin.Context)

Get Search by ID @Tags Menu @Summary Get by ID @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.Menu @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 404 {object} response.ErrorResult "{error:{code:0,message:NotFound}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus/{id} [get]

func (*Menu) Query

func (a *Menu) Query(c *gin.Context)

Query Search menu @Tags Menu @Summary Search menu @Security ApiKeyAuth @Param current query int true "Current page" default(1) @Param pageSize query int true "Page size" default(10) @Param queryValue query string false "Search value" @Param status query int false "Status(1:enable 2:disable)" @Param showStatus query int false "Show status(1:show 2:hide)" @Param parentID query string false "Parent ID" @Success 200 {object} response.ListResult{list=[]response.Menu} "Search Result" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus [get]

func (*Menu) QueryTree

func (a *Menu) QueryTree(c *gin.Context)

QueryTree Search menu tree @Tags Menu @Summary Search menu tree @Security ApiKeyAuth @Param status query int false "Status(1:enable 2:disable)" @Param parentID query string false "Parent ID" @Success 200 {object} response.ListResult{list=[]response.MenuTree} "Search Result" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus.tree [get]

func (*Menu) Update

func (a *Menu) Update(c *gin.Context)

Update Update @Tags Menu @Summary Update @Security ApiKeyAuth @Param id path string true "UUID" @Param body body request.Menu true "Update" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/menus/{id} [put]

type Role

type Role struct {
}

func (*Role) Create

func (a *Role) Create(c *gin.Context)

Create Create @Tags Role @Summary Create @Security ApiKeyAuth @Param body body request.Role true "Create" @Success 200 {object} response.IDResult @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles [post]

func (*Role) Delete

func (a *Role) Delete(c *gin.Context)

Delete Delete @Tags Role @Summary Delete @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles/{id} [delete]

func (*Role) Disable

func (a *Role) Disable(c *gin.Context)

Disable Disable @Tags Role @Summary Disable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles/{id}/disable [patch]

func (*Role) Enable

func (a *Role) Enable(c *gin.Context)

Enable Enable @Tags Role @Summary Enable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles/{id}/enable [patch]

func (*Role) Get

func (a *Role) Get(c *gin.Context)

Get Get by ID @Tags Role @Summary Get by ID @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.Role @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 404 {object} response.ErrorResult "{error:{code:0,message:NotFound}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles/{id} [get]

func (*Role) Query

func (a *Role) Query(c *gin.Context)

Query Search role @Tags Role @Summary Search role @Security ApiKeyAuth @Param current query int true "Current page" default(1) @Param pageSize query int true "Page size" default(10) @Param queryValue query string false "Search value" @Param status query int false "Status(1:enable 2:disable)" @Success 200 {object} response.ListResult{list=[]response.Role} "Search Result" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles [get]

func (*Role) QuerySelect

func (a *Role) QuerySelect(c *gin.Context)

QuerySelect Search selected data @Tags Role @Summary Search selected data @Security ApiKeyAuth @Param queryValue query string false "Search value" @Param status query int false "Status(1:enable 2:disable)" @Success 200 {object} response.ListResult{list=[]response.Role} "Search Result" @Failure 400 {object} response.ErrorResult "{error:{code:0,message:未知的查询类型}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles.select [get]

func (*Role) Update

func (a *Role) Update(c *gin.Context)

Update Update @Tags Role @Summary Update @Security ApiKeyAuth @Param id path string true "UUID" @Param body body request.Role true "Update" @Success 200 {object} response.Role @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/roles/{id} [put]

type User

type User struct {
}

func (*User) Create

func (a *User) Create(c *gin.Context)

Create Create @Tags User @Summary Create @Security ApiKeyAuth @Param body body request.User true "Create" @Success 200 {object} response.IDResult @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users [post]

func (*User) Delete

func (a *User) Delete(c *gin.Context)

Delete Delete @Tags User @Summary Delete @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users/{id} [delete]

func (*User) Disable

func (a *User) Disable(c *gin.Context)

Disable Disable @Tags User @Summary Disable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users/{id}/disable [patch]

func (*User) Enable

func (a *User) Enable(c *gin.Context)

Enable Enable @Tags User @Summary Enable @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.StatusResult "{status:OK}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users/{id}/enable [patch]

func (*User) Get

func (a *User) Get(c *gin.Context)

Get Get by ID @Tags User @Summary Get by ID @Security ApiKeyAuth @Param id path string true "UUID" @Success 200 {object} response.User @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 404 {object} response.ErrorResult "{error:{code:0,message:NotFound}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users/{id} [get]

func (*User) Query

func (a *User) Query(c *gin.Context)

Query Search user @Tags User @Summary Search user @Security ApiKeyAuth @Param current query int true "Current page" default(1) @Param pageSize query int true "Page size" default(10) @Param queryValue query string false "Search value" @Param roleIDs query string false "Role IDs(Comma division)" @Param status query int false "Status (1: Enabled 2: Disabled)" @Success 200 {object} response.ListResult{list=[]response.UserShow} "Search Result" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users [get]

func (*User) Update

func (a *User) Update(c *gin.Context)

Update Update @Tags User @Summary Update @Security ApiKeyAuth @Param id path string true "UUID" @Param body body request.User true "Update" @Success 200 {object} response.User @Failure 400 {object} response.ErrorResult "{error:{code:0,message:BadRequest}}" @Failure 401 {object} response.ErrorResult "{error:{code:0,message:Unauthorized}}" @Failure 500 {object} response.ErrorResult "{error:{code:0,message:SystemError}}" @Router /api/v1/users/{id} [put]