v1

Documentation

Index

• Variables
• type FileApi
  • func (a *FileApi) RegisterRoute(r *gin.RouterGroup)
  • func (a *FileApi) UploadFile(c *gin.Context)
• type MonitorApi
  • func (a *MonitorApi) Index(c *gin.Context)
  • func (a *MonitorApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, ...)
• type MsgApi
  • func (a *MsgApi) Create(c *gin.Context)
  • func (a *MsgApi) Delete(c *gin.Context)
  • func (a *MsgApi) GetPage(c *gin.Context)
  • func (a *MsgApi) RegisterRoute(r *gin.RouterGroup, authMiddleware *jwt.GinJWTMiddleware, ...)
  • func (a *MsgApi) Update(c *gin.Context)
• 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)

Variables

var FileApiSet = wire.NewSet(wire.Struct(new(FileApi), "*"))

var MonitorApiSet = wire.NewSet(wire.Struct(new(MonitorApi), "*"))

var MsgApiSet = wire.NewSet(wire.Struct(new(MsgApi), "*"))

var ProviderSet = wire.NewSet(FileApiSet, MonitorApiSet, UserSet, MsgApiSet)

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

Types

type FileApi

type FileApi struct {
	FileSrv *service.FileSrv
}

func (*FileApi) RegisterRoute

func (a *FileApi) RegisterRoute(r *gin.RouterGroup)

RegisterRoute 注册路由

func (*FileApi) UploadFile

func (a *FileApi) UploadFile(c *gin.Context)

@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

type MsgApi struct {
	MsgSrv *service.MsgSrv
}

func (*MsgApi) Create

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

@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

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

@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

func (a *MsgApi) GetPage(c *gin.Context)

@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 注册路由

func (*MsgApi) Update

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

@Tags 公告管理 @Summary 更新公告 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data body schema.NoticeUpdateReq true "请求参数" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /msg/notice [put]

type UserApi

type UserApi struct {
	UserSrv *service.UserSrv
}

func (*UserApi) Create

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

@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

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

@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

func (a *UserApi) GetPage(c *gin.Context)

@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

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

@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 注册路由

func (*UserApi) Update

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

@Tags UserApi @Summary 修改用户 @Accept application/json @Produce application/json @Security ApiKeyAuth @Param data body schema.UserUpdateReq true "请求参数" @Success 200 {object} ginx.ResponseData{} "成功结果" @Failure 500 {object} ginx.ResponseFail{} "失败结果" @Router /user [put]