Documentation
¶
Index ¶
- Variables
- type CaptchaController
- type MenuController
- func (a MenuController) Create(ctx echo.Context) error
- func (a MenuController) Delete(ctx echo.Context) error
- func (a MenuController) Disable(ctx echo.Context) error
- func (a MenuController) Enable(ctx echo.Context) error
- func (a MenuController) Get(ctx echo.Context) error
- func (a MenuController) GetActions(ctx echo.Context) error
- func (a MenuController) Query(ctx echo.Context) error
- func (a MenuController) Update(ctx echo.Context) error
- func (a MenuController) UpdateActions(ctx echo.Context) error
- type PublicController
- type RoleController
- func (a RoleController) Create(ctx echo.Context) error
- func (a RoleController) Delete(ctx echo.Context) error
- func (a RoleController) Disable(ctx echo.Context) error
- func (a RoleController) Enable(ctx echo.Context) error
- func (a RoleController) Get(ctx echo.Context) error
- func (a RoleController) GetAll(ctx echo.Context) error
- func (a RoleController) Query(ctx echo.Context) error
- func (a RoleController) Update(ctx echo.Context) error
- type UserController
- func (a UserController) Create(ctx echo.Context) error
- func (a UserController) Delete(ctx echo.Context) error
- func (a UserController) Disable(ctx echo.Context) error
- func (a UserController) Enable(ctx echo.Context) error
- func (a UserController) Get(ctx echo.Context) error
- func (a UserController) Query(ctx echo.Context) error
- func (a UserController) Update(ctx echo.Context) error
Constants ¶
This section is empty.
Variables ¶
var Module = fx.Options( fx.Provide(NewPublicController), fx.Provide(NewCaptchaController), fx.Provide(NewUserController), fx.Provide(NewRoleController), fx.Provide(NewMenuController), )
Module exported for initializing application
Functions ¶
This section is empty.
Types ¶
type CaptchaController ¶
type CaptchaController struct {
// contains filtered or unexported fields
}
func NewCaptchaController ¶
func NewCaptchaController(captcha lib.Captcha) CaptchaController
NewUserController creates new user controller
func (CaptchaController) GetCaptcha ¶
func (a CaptchaController) GetCaptcha(ctx echo.Context) error
@Tags Public @Summary Get Captcha @Produce application/json @failure 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @Router /api/public/captcha [get]
func (CaptchaController) VerifyCaptcha ¶
func (a CaptchaController) VerifyCaptcha(ctx echo.Context) error
@Tags Public @Summary Verify Captcha @Produce application/json @Param data body dto.CaptchaVerify true "CaptchaVerify" @Success 200 {string} echox.Response "ok" @failure 400 {string} echox.Response "bad request" @Router /api/public/captcha/verify [post]
type MenuController ¶
type MenuController struct {
// contains filtered or unexported fields
}
func NewMenuController ¶
func NewMenuController( logger lib.Logger, menuService services.MenuService, ) MenuController
NewMenuController creates new menu controller
func (MenuController) Create ¶
func (a MenuController) Create(ctx echo.Context) error
@tags Menu @summary Menu Create @produce application/json @param data body models.Menu true "Menu" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus [post]
func (MenuController) Delete ¶
func (a MenuController) Delete(ctx echo.Context) error
@tags Menu @summary Menu Delete By ID @produce application/json @param id path int true "menu id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id} [delete]
func (MenuController) Disable ¶
func (a MenuController) Disable(ctx echo.Context) error
@tags Menu @summary Menu Disable By ID @produce application/json @param id path int true "menu id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id}/disable [patch]
func (MenuController) Enable ¶
func (a MenuController) Enable(ctx echo.Context) error
@tags Menu @summary Menu Enable By ID @produce application/json @param id path int true "menu id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id}/enable [patch]
func (MenuController) Get ¶
func (a MenuController) Get(ctx echo.Context) error
@tags Menu @summary Menu Get By ID @produce application/json @param id path int true "menu id" @success 200 {object} echox.Response{data=models.Menu} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id} [get]
func (MenuController) GetActions ¶
func (a MenuController) GetActions(ctx echo.Context) error
@tags Menu @summary MenuActions Get By menuID @produce application/json @param id path int true "menu id" @success 200 {object} echox.Response{data=models.MenuActions} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id}/actions [get]
func (MenuController) Query ¶
func (a MenuController) Query(ctx echo.Context) error
@tags Menu @summary Menu Query @produce application/json @param data query models.MenuQueryParam true "MenuQueryParam" @success 200 {object} echox.Response{data=models.MenuQueryResult} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus [get]
func (MenuController) Update ¶
func (a MenuController) Update(ctx echo.Context) error
@tags Menu @summary Menu Update By ID @produce application/json @param id path int true "menu id" @param data body models.Menu true "Menu" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id} [put]
func (MenuController) UpdateActions ¶
func (a MenuController) UpdateActions(ctx echo.Context) error
@tags Menu @summary Menu Actions Update By menuID @produce application/json @param id path int true "menu id" @param data body models.MenuActions true "Menu" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/menus/{id}/actions [put]
type PublicController ¶
type PublicController struct {
// contains filtered or unexported fields
}
func NewPublicController ¶
func NewPublicController( userService services.UserService, authService services.AuthService, captcha lib.Captcha, logger lib.Logger, ) PublicController
NewPublicController creates new public controller
func (PublicController) MenuTree ¶
func (a PublicController) MenuTree(ctx echo.Context) error
@Tags Public @Summary UserMenuTree @Produce application/json @Success 200 {string} echox.Response{data=models.MenuTrees} "ok" @failure 400 {string} echox.Response "bad request" @failure 500 {string} echox.Response "internal error" @Router /api/publics/user/menutree [get]
func (PublicController) SysRoutes ¶
func (a PublicController) SysRoutes(ctx echo.Context) error
@Tags Public @Summary UserLogin @Produce application/json @Param data body dto.Login true "Login" @Success 200 {string} echox.Response "ok" @failure 400 {string} echox.Response "bad request" @failure 500 {string} echox.Response "internal error" @Router /api/publics/sys/routes [post]
func (PublicController) UserInfo ¶
func (a PublicController) UserInfo(ctx echo.Context) error
@Tags Public @Summary UserInfo @Produce application/json @Success 200 {string} echox.Response{data=models.UserInfo} "ok" @failure 400 {string} echox.Response "bad request" @failure 500 {string} echox.Response "internal error" @Router /api/publics/user [get]
func (PublicController) UserLogin ¶
func (a PublicController) UserLogin(ctx echo.Context) error
@Tags Public @Summary UserLogin @Produce application/json @Param data body dto.Login true "Login" @Success 200 {string} echox.Response "ok" @failure 400 {string} echox.Response "bad request" @failure 500 {string} echox.Response "internal error" @Router /api/publics/user/login [post]
func (PublicController) UserLogout ¶
func (a PublicController) UserLogout(ctx echo.Context) error
@Tags Public @Summary UserLogout @Produce application/json @Success 200 {string} echox.Response "success" @Router /api/publics/user/logout [post]
type RoleController ¶
type RoleController struct {
// contains filtered or unexported fields
}
func NewRoleController ¶
func NewRoleController( logger lib.Logger, roleService services.RoleService, ) RoleController
NewRoleController creates new role controller
func (RoleController) Create ¶
func (a RoleController) Create(ctx echo.Context) error
@tags Role @summary Role Create @produce application/json @param data body models.Role true "Role" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles [post]
func (RoleController) Delete ¶
func (a RoleController) Delete(ctx echo.Context) error
@tags Role @summary Role Delete By ID @produce application/json @param id path int true "role id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles/{id} [delete]
func (RoleController) Disable ¶
func (a RoleController) Disable(ctx echo.Context) error
@tags Role @summary Role Disable By ID @produce application/json @param id path int true "role id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles/{id}/disable [patch]
func (RoleController) Enable ¶
func (a RoleController) Enable(ctx echo.Context) error
@tags Role @summary Role Enable By ID @produce application/json @param id path int true "role id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles/{id}/enable [patch]
func (RoleController) Get ¶
func (a RoleController) Get(ctx echo.Context) error
@tags Role @summary Role Get By ID @produce application/json @param id path int true "role id" @success 200 {object} echox.Response{data=models.Role} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles/{id} [get]
func (RoleController) GetAll ¶
func (a RoleController) GetAll(ctx echo.Context) error
@tags Role @summary Role Get All @produce application/json @param data query models.RoleQueryParam true "RoleQueryParam" @success 200 {object} echox.Response{data=models.Roles} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles [get]
func (RoleController) Query ¶
func (a RoleController) Query(ctx echo.Context) error
@tags Role @summary Role Query @produce application/json @param data query models.RoleQueryParam true "RoleQueryParam" @success 200 {object} echox.Response{data=models.RoleQueryResult} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles [get]
func (RoleController) Update ¶
func (a RoleController) Update(ctx echo.Context) error
@tags Role @summary Role Update By ID @produce application/json @param id path int true "role id" @param data body models.Role true "Role" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/roles/{id} [put]
type UserController ¶
type UserController struct {
// contains filtered or unexported fields
}
func NewUserController ¶
func NewUserController(userService services.UserService, logger lib.Logger) UserController
NewUserController creates new user controller
func (UserController) Create ¶
func (a UserController) Create(ctx echo.Context) error
@tags User @summary User Create @produce application/json @param data body models.User true "User" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users [post]
func (UserController) Delete ¶
func (a UserController) Delete(ctx echo.Context) error
@tags User @summary User Delete By ID @produce application/json @param id path int true "user id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users/{id} [delete]
func (UserController) Disable ¶
func (a UserController) Disable(ctx echo.Context) error
@tags User @summary User Disable By ID @produce application/json @param id path int true "user id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users/{id}/disable [patch]
func (UserController) Enable ¶
func (a UserController) Enable(ctx echo.Context) error
@tags User @summary User Enable By ID @produce application/json @param id path int true "user id" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users/{id}/enable [patch]
func (UserController) Get ¶
func (a UserController) Get(ctx echo.Context) error
@tags User @summary User Get By ID @produce application/json @param id path int true "user id" @success 200 {object} echox.Response{data=models.User} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users/{id} [get]
func (UserController) Query ¶
func (a UserController) Query(ctx echo.Context) error
@tags User @summary User Query @produce application/json @param data query models.UserQueryParam true "UserQueryParam" @success 200 {object} echox.Response{data=models.UserQueryResult} "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users [get]
func (UserController) Update ¶
func (a UserController) Update(ctx echo.Context) error
@tags User @summary User Update By ID @produce application/json @param id path int true "user id" @param data body models.User true "User" @success 200 {object} echox.Response "ok" @failure 400 {object} echox.Response "bad request" @failure 500 {object} echox.Response "internal error" @router /api/users/{id} [put]
Source Files