api

Documentation

Index

• type AppApi
  • func (*AppApi) ChangeLogo(c *gin.Context)
  • func (*AppApi) Create(c *gin.Context)
  • func (*AppApi) Delete(c *gin.Context)
  • func (*AppApi) Info(c *gin.Context)
  • func (*AppApi) Update(c *gin.Context)
• type FileAPI
  • func (*FileAPI) Download(c *gin.Context)
  • func (*FileAPI) InitialUpload(c *gin.Context)
  • func (*FileAPI) MergePart(c *gin.Context)
  • func (*FileAPI) UploadPart(c *gin.Context)
• type HLKApi
  • func (api *HLKApi) QueryJobInfo(c *gin.Context)
• type OpenApi
  • func (*OpenApi) Create(c *gin.Context)
  • func (*OpenApi) Update(c *gin.Context)
• type UserApi
  • func (*UserApi) ChangeAvatar(c *gin.Context)
  • func (*UserApi) ChangePassword(c *gin.Context)
  • func (*UserApi) Info(c *gin.Context)
  • func (*UserApi) Login(c *gin.Context)
  • func (*UserApi) Logout(c *gin.Context)
  • func (*UserApi) Register(c *gin.Context)
  • func (*UserApi) UpdateInfo(c *gin.Context)

Types

type AppApi

type AppApi struct{}

AppApi 应用管理模块

func (*AppApi) ChangeLogo

func (*AppApi) ChangeLogo(c *gin.Context)

ChangeLogo 修改应用图标

func (*AppApi) Create

func (*AppApi) Create(c *gin.Context)

Create 注册应用

func (*AppApi) Delete

func (*AppApi) Delete(c *gin.Context)

Delete 注销应用

func (*AppApi) Info

func (*AppApi) Info(c *gin.Context)

Info 获取应用信息

func (*AppApi) Update

func (*AppApi) Update(c *gin.Context)

Update 更新应用

type FileAPI

type FileAPI struct{}

FileAPI 文件分片上传接口

func (*FileAPI) Download

func (*FileAPI) Download(c *gin.Context)

Download godoc

@Summary	下载
@Tags		file-api
@Accept		x-www-form-urlencoded
@produce	octet-stream
@Param		Authorization	header	string	true	"jwt凭证"
@Param		fileId			query	string	true	"文件Id"
@Router		/api/file/download [get]

func (*FileAPI) InitialUpload

func (*FileAPI) InitialUpload(c *gin.Context)

InitialUpload godoc

@Summary	初始化分片上传
@Tags		file-api
@Accept		json
@Produce	json
@Param		Authorization	header		string							true	"jwt凭证"
@Param		reqBody			body		protocol.File_InitialUploadReq	true	"reqBody"
@Success	200				{object}	protocol.File_InitialUploadRsp
@Router		/api/file/initialUpload [post]

func (*FileAPI) MergePart

func (*FileAPI) MergePart(c *gin.Context)

MergePart godoc

@Summary	合并分片
@Tags		file-api
@Accept		x-www-form-urlencoded
@Param		Authorization	header		string	true	"jwt凭证"
@Param		fileId			body		string	true	"文件Id"
@Success	200				{object}	nil
@Router		/api/file/mergePart [post]

func (*FileAPI) UploadPart

func (*FileAPI) UploadPart(c *gin.Context)

UploadPart godoc

@Summary	上传分片
@Tags		file-api
@Accept		mpfd
@Param		Authorization	header		string	true	"jwt凭证"
@Param		file			formData	file	true	"文件"
@Param		fileId			formData	string	true	"分片序号"
@Param		chunkNum		formData	integer	true	"文件Id"
@Success	200				{object}	nil
@Router		/api/file/uploadPart [patch]

type HLKApi

type HLKApi struct{}

HLKApi 供 hlk_manager 使用的相关接口

func (*HLKApi) QueryJobInfo

func (api *HLKApi) QueryJobInfo(c *gin.Context)

QueryJobInfo 获取任务信息

type OpenApi

type OpenApi struct{}

OpenApi 凭证管理模块

func (*OpenApi) Create

func (*OpenApi) Create(c *gin.Context)

Create 创建凭证

func (*OpenApi) Update

func (*OpenApi) Update(c *gin.Context)

Update 更新凭证

type UserApi

type UserApi struct{}

UserApi 用户管理模块

func (*UserApi) ChangeAvatar

func (*UserApi) ChangeAvatar(c *gin.Context)

ChangeAvatar 修改头像

func (*UserApi) ChangePassword

func (*UserApi) ChangePassword(c *gin.Context)

ChangePassword 修改密码

func (*UserApi) Info

func (*UserApi) Info(c *gin.Context)

Info 获取个人信息

func (*UserApi) Login

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

Login 登录

func (*UserApi) Logout

func (*UserApi) Logout(c *gin.Context)

Logout 登出

func (*UserApi) Register

func (*UserApi) Register(c *gin.Context)

Register 注册

func (*UserApi) UpdateInfo

func (*UserApi) UpdateInfo(c *gin.Context)

UpdateInfo 更新个人信息