Documentation
¶
Index ¶
- Variables
- type FileApi
- type MonitorApi
- type MsgApi
- type UserApi
- func (a *UserApi) Create(c *gin.Context)
- func (a *UserApi) Delete(c *gin.Context)
- func (a *UserApi) GetPage(c *gin.Context)
- func (a *UserApi) GetUserInfo(c *gin.Context)
- func (a *UserApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, ...)
- func (a *UserApi) Update(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
var MonitorApiSet = wire.NewSet(wire.Struct(new(MonitorApi), "*"))
var ProviderSet = wire.NewSet(FileApiSet, MonitorApiSet, UserSet, MsgApiSet)
Functions ¶
This section is empty.
Types ¶
type FileApi ¶
func (*FileApi) RegisterRoute ¶
func (a *FileApi) RegisterRoute(r *gin.RouterGroup)
RegisterRoute 注册路由
func (*FileApi) UploadFile ¶
@Tags 文件管理 @Summary 上传文件 @Accept multipart/form-data @Produce application/json @Param file formData file true "file" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /public/uploadFile [post]
type MonitorApi ¶
type MonitorApi struct {
MonitorSrv *service.MonitorSrv
}
func (*MonitorApi) Index ¶
func (a *MonitorApi) Index(c *gin.Context)
@Tags 服务器状态 @Summary 获取服务器状态 @Accept application/json @Produce application/json @Security ApiKeyAuth @Success 200 {object} ginx.ResponseData{data=monitor.Server} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /monitor/index [get]
func (*MonitorApi) RegisterRoute ¶
func (a *MonitorApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, adminMiddleware *jwt.GinJWTMiddleware)
RegisterRoute 注册路由
type MsgApi ¶
func (*MsgApi) Create ¶
@Tags 公告管理 @Summary 新建公告 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data body schema.NoticeCreateReq true "请求参数" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /msg/notice [post]
func (*MsgApi) Delete ¶
@Tags 公告管理 @Summary 删除公告 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param id path uint64 true "公告id" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /msg/notice/{id} [delete]
func (*MsgApi) GetPage ¶
@Tags 公告管理 @Summary 获取公告列表 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data query schema.NoticeGetPageReq true "请求参数" @Success 200 {object} ginx.ResponseData{data=schema.NoticeGetPageResp} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /msg/notice [get]
func (*MsgApi) RegisterRoute ¶
func (a *MsgApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, adminMiddleware *jwt.GinJWTMiddleware)
RegisterRoute 注册路由
type UserApi ¶
func (*UserApi) Create ¶
@Tags UserApi @Summary 新建用户 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data body schema.UserCreateReq true "请求参数" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /user [post]
func (*UserApi) Delete ¶
@Tags UserApi @Summary 删除用户 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param id path uint64 true "id" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /user/{id} [delete]
func (*UserApi) GetPage ¶
@Tags UserApi @Summary 获取用户列表 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data query schema.UserGetPageReq true "请求参数" @Success 200 {object} ginx.ResponseData{data=schema.UserGetPageReqResult} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /user/list [get]
func (*UserApi) GetUserInfo ¶
@Tags UserApi @Summary 获取用户信息 @Accept application/json @Produce application/json @Security ApiKeyAuth @Success 200 {object} ginx.ResponseData{data=schema.UserInfo} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /user/info [get]
func (*UserApi) RegisterRoute ¶
func (a *UserApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, adminMiddleware *jwt.GinJWTMiddleware)
RegisterRoute 注册路由
Source Files