Documentation
¶
Index ¶
- func AddFriend(c *gin.Context)
- func Admin(c *gin.Context)
- func DeleteFriend(c *gin.Context)
- func DeleteMessage(c *gin.Context)
- func GetCode(c *gin.Context)
- func GetFriendInfo(c *gin.Context)
- func GetMyFriends(c *gin.Context)
- func GetMyInfo(c *gin.Context)
- func HandleWebSocket(c *gin.Context)
- func Login(c *gin.Context)
- func Logout(c *gin.Context)
- func ReceiveMessage(c *gin.Context)
- func Register(c *gin.Context)
- func SendMessage(c *gin.Context)
- func UpdateFriendNote(c *gin.Context)
- func UpdateMessage(c *gin.Context)
- func UpdateMyInfo(c *gin.Context)
- func Upload(c *gin.Context)
- type ErrorResponse
- type Response
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddFriend ¶
@Summary 添加好友 @Description 当前用户添加好友 @Tags friend @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标用户 ID" @Success 200 {object} model.User @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/friend/:id [post]
func Admin ¶
@Summary 管理员登录 @Description Administrator Login @Tags user @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/admin [post]
func DeleteFriend ¶
@Summary 移除好友 @Description 当前用户移除好友 @Tags friend @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标用户 ID" @Success 200 {object} model.User @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/friend/:id [delete]
func DeleteMessage ¶
@Summary 删除消息 @Description 删除我发送的消息 @Tags message @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标消息 ID" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/message/:id [delete]
func GetFriendInfo ¶
@Summary 获取朋友信息 @Description 获取当前用户指定好友信息 @Tags friend @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标用户 ID" @Success 200 {object} model.User @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/friend/:id [get]
func GetMyFriends ¶
@Summary 获取朋友列表 @Description 获取当前用户所有好友 @Tags friend @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {array} model.User @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/friends/ [get]
func GetMyInfo ¶
@Summary 获取我的个人信息 @Description Get my personal information. @Tags me @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/me/info [get]
func HandleWebSocket ¶
@Summary 用户通信 @Description 通过建立websocket协议进行用户间通信 收发消息 @Tags ws @Accept json @Produce json @Param user_id path string true "ID" @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/ws [get]
func Login ¶
@Summary 用户登录 @Description User Login @Tags user @Accept json @Produce json @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/login [post]
func Logout ¶
@Summary 用户登出 @Description Log Out @Tags user @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/logout [post]
func ReceiveMessage ¶
@Summary 接收消息 @Description 接收发送给我的消息 @Tags message @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/message [get]
func Register ¶
@Summary 用户注册 @Description User Registration @Tags user @Accept json @Produce json @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/register [post]
func SendMessage ¶
@Summary 发送消息 @Description 发送我要发送的消息 @Tags message @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/message [post]
func UpdateFriendNote ¶
@Summary 更新朋友备注 @Description 当前用户更新好友备注 @Tags friend @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标用户 ID" @Success 200 {object} model.User @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/friend/:id [put]
func UpdateMessage ¶
@Summary 更新消息 @Description 更新我发送的消息 @Tags message @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Param user_id path string true "目标消息 ID" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/message/:id [put]
func UpdateMyInfo ¶
@Summary 更新我的个人信息 @Description Update my personal information. @Tags me @Accept json @Produce json @Param Authorization header string true "Bearer {token}" @Success 200 {object} Response @Failure 400 {object} ErrorResponse @Failure 401 {object} ErrorResponse @Failure 404 {object} ErrorResponse @Router /v1/me/info [put]
func Upload ¶
UploadImage godoc @Summary 上传文件 @Description 上传文件 @Accept multipart/form-data @Produce json @Security ApiKeyAuth @Param file formData file true "上传的文件" @Success 200 {object} UploadResponse "上传成功" @Failure 400 {object} ErrorResponse "请求参数错误" @Failure 401 {object} ErrorResponse "未认证授权" @Failure 500 {object} ErrorResponse "服务器内部错误" @Router /upload [post]
Types ¶
type ErrorResponse ¶
错误响应
Source Files