Documentation
¶
Index ¶
- func DeleteUser(ctx echo.Context) error
- func DeleteUserAll(ctx echo.Context) error
- func DeleteUserCustomConf(ctx echo.Context) error
- func DeleteUserImage(ctx echo.Context) error
- func GetUserAllUsername(ctx echo.Context) error
- func GetUserAvatar(ctx echo.Context) error
- func GetUserCustomConf(ctx echo.Context) error
- func GetUserImage(ctx echo.Context) error
- func GetUserInfo(ctx echo.Context) error
- func GetUserInfoByUsername(ctx echo.Context) error
- func GetUserStatus(ctx echo.Context) error
- func PostUserCustomConf(ctx echo.Context) error
- func PostUserLogin(ctx echo.Context) error
- func PostUserRefreshToken(ctx echo.Context) error
- func PostUserRegister(ctx echo.Context) error
- func PostUserUploadImage(ctx echo.Context) error
- func PutUserAvatar(ctx echo.Context) error
- func PutUserDesc(ctx echo.Context) error
- func PutUserImage(ctx echo.Context) error
- func PutUserInfo(ctx echo.Context) error
- func PutUserNick(ctx echo.Context) error
- func PutUserPassword(ctx echo.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteUser ¶
func DeleteUser(ctx echo.Context) error
*
- @description:
- @param {path} id string "user id"
- @method:DELETE
- @router:/user/delete/:id
func DeleteUserAll ¶
func DeleteUserAll(ctx echo.Context) error
func DeleteUserCustomConf ¶
func DeleteUserCustomConf(ctx echo.Context) error
*
- @description: delete user custom config
- @param {path} key string
- @method:delete
- @router:/user/custom/:key
func DeleteUserImage ¶
func DeleteUserImage(ctx echo.Context) error
func GetUserAllUsername ¶
func GetUserAllUsername(ctx echo.Context) error
*
- @description: get all Usernames
- @method:GET
- @router:/user/all/name
func GetUserAvatar ¶
func GetUserAvatar(ctx echo.Context) error
@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(ctx echo.Context) error
*
- @description:get custom file by user
- @param {path} name string "file name"
- @method: GET
- @router: /user/custom/:key
func GetUserImage ¶
func GetUserImage(ctx echo.Context) error
*
- @description: get current user's image
- @method:GET
- @router:/user/image/:id
func GetUserInfo ¶
func GetUserInfo(ctx echo.Context) error
@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(ctx echo.Context) error
*
- @description:
- @param {*gin.Context} c
- @param {string} Username
- @return {*}
- @method:
- @router:
func GetUserStatus ¶
func GetUserStatus(ctx echo.Context) error
@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(ctx echo.Context) error
*
- @description:create or update custom conf by user
- @param {path} name string "file name"
- @method:POST
- @router:/user/custom/:key
func PostUserLogin ¶
func PostUserLogin(ctx echo.Context) error
@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(ctx echo.Context) error
*
- @description:
- @param {*gin.Context} c
- @param {string} refresh_token
- @return {*}
- @method:
- @router:
func PostUserRegister ¶
func PostUserRegister(ctx echo.Context) error
@Summary register user @Router /user/register/ [post]
func PostUserUploadImage ¶
func PostUserUploadImage(ctx echo.Context) error
* * @description: * @param {*gin.Context} c * @param {file} file * @param {string} key * @param {string} type:avatar,background * @return {*} * @method: * @router:
func PutUserAvatar ¶
func PutUserAvatar(ctx echo.Context) error
@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(ctx echo.Context) error
@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(ctx echo.Context) error
*
- @description:update user image
- @method:POST
- @router:/user/current/image/:key
func PutUserInfo ¶
func PutUserInfo(ctx echo.Context) error
@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(ctx echo.Context) error
@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(ctx echo.Context) error
@Summary edit user password @Produce application/json @Accept application/json @Tags user @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /user/password/:id [put]
Types ¶
This section is empty.
Source Files