v1

Documentation

Index

• func DeleteUser(c *gin.Context)
• func DeleteUserAll(c *gin.Context)
• func DeleteUserCustomConf(c *gin.Context)
• func DeleteUserImage(c *gin.Context)
• func GetUserAllUsername(c *gin.Context)
• func GetUserAvatar(c *gin.Context)
• func GetUserCustomConf(c *gin.Context)
• func GetUserImage(c *gin.Context)
• func GetUserInfo(c *gin.Context)
• func GetUserInfoByUsername(c *gin.Context)
• func GetUserStatus(c *gin.Context)
• func PostUserCustomConf(c *gin.Context)
• func PostUserLogin(c *gin.Context)
• func PostUserRefreshToken(c *gin.Context)
• func PostUserRegister(c *gin.Context)
• func PostUserUploadImage(c *gin.Context)
• func PutUserAvatar(c *gin.Context)
• func PutUserDesc(c *gin.Context)
• func PutUserImage(c *gin.Context)
• func PutUserInfo(c *gin.Context)
• func PutUserNick(c *gin.Context)
• func PutUserPassword(c *gin.Context)

Functions

func DeleteUser

func DeleteUser(c *gin.Context)

*

• @description:
• @param {path} id string "user id"
• @method:DELETE
• @router:/user/delete/:id

func DeleteUserAll

func DeleteUserAll(c *gin.Context)

func DeleteUserCustomConf

func DeleteUserCustomConf(c *gin.Context)

*

• @description: delete user custom config
• @param {path} key string
• @method:delete
• @router:/user/custom/:key

func DeleteUserImage

func DeleteUserImage(c *gin.Context)

func GetUserAllUsername

func GetUserAllUsername(c *gin.Context)

*

• @description: get all Usernames
• @method:GET
• @router:/user/all/name

func GetUserAvatar

func GetUserAvatar(c *gin.Context)

@Summary get user head @Produce application/json @Tags user @Param file formData file true "用户头像" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /users/avatar [get]

func GetUserCustomConf

func GetUserCustomConf(c *gin.Context)

*

• @description:get custom file by user
• @param {path} name string "file name"
• @method: GET
• @router: /user/custom/:key

func GetUserImage

func GetUserImage(c *gin.Context)

*

• @description: get current user's image
• @method:GET
• @router:/user/image/:id

func GetUserInfo

func GetUserInfo(c *gin.Context)

@Summary get user info @Produce application/json @Accept application/json @Tags user @Success 200 {string} string "ok" @Router /user/info/:id [get]

func GetUserInfoByUsername

func GetUserInfoByUsername(c *gin.Context)

*

• @description:
• @param {*gin.Context} c
• @param {string} Username
• @return {*}
• @method:
• @router:

func GetUserStatus

func GetUserStatus(c *gin.Context)

@Summary 检查是否进入引导状态 @Produce application/json @Accept application/json @Tags sys @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /sys/init/check [get]

func PostUserCustomConf

func PostUserCustomConf(c *gin.Context)

*

• @description:create or update custom conf by user
• @param {path} name string "file name"
• @method:POST
• @router:/user/custom/:key

func PostUserLogin

func PostUserLogin(c *gin.Context)

@Summary login @Produce application/json @Accept application/json @Tags user @Param user_name query string true "User name" @Param pwd query string true "password" @Success 200 {string} string "ok" @Router /user/login [post]

func PostUserRefreshToken

func PostUserRefreshToken(c *gin.Context)

*

• @description:
• @param {*gin.Context} c
• @param {string} refresh_token
• @return {*}
• @method:
• @router:

func PostUserRegister

func PostUserRegister(c *gin.Context)

@Summary register user @Router /user/register/ [post]

func PostUserUploadImage

func PostUserUploadImage(c *gin.Context)

* * @description: * @param {*gin.Context} c * @param {file} file * @param {string} key * @param {string} type:avatar,background * @return {*} * @method: * @router:

func PutUserAvatar

func PutUserAvatar(c *gin.Context)

@Summary edit user head @Produce application/json @Accept multipart/form-data @Tags user @Param file formData file true "用户头像" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /users/avatar [put]

func PutUserDesc

func PutUserDesc(c *gin.Context)

@Summary edit user description @Produce application/json @Accept multipart/form-data @Tags user @Param description formData string false "Description" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/desc [put]

func PutUserImage

func PutUserImage(c *gin.Context)

*

• @description:update user image
• @method:POST
• @router:/user/current/image/:key

func PutUserInfo

func PutUserInfo(c *gin.Context)

@Summary edit user name @Produce application/json @Accept application/json @Tags user @Param old_name query string true "Old user name" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/name/:id [put]

func PutUserNick

func PutUserNick(c *gin.Context)

@Summary edit user nick @Produce application/json @Accept application/json @Tags user @Param nick_name query string false "nick name" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/nick [put]

func PutUserPassword

func PutUserPassword(c *gin.Context)

@Summary edit user password @Produce application/json @Accept application/json @Tags user @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/password/:id [put]