IM/doc_api/http_api.json

5552 lines
139 KiB
JSON

{
"generatedAt": "2026-04-29T16:33:59.996Z",
"routeRoot": "/api/web",
"totalEndpoints": 121,
"endpoints": [
{
"controllerFile": "src/controller/web/channel/channel_chat_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-chat/add-friend-channel-chat",
"subPath": "/add-friend-channel-chat",
"description": "发送好友频道聊天",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "message",
"source": "body",
"required": false
},
{
"name": "toUserId",
"source": "body",
"required": true
},
{
"name": "toUserName",
"source": "body",
"required": true
},
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "atUserId",
"source": "body",
"required": true
},
{
"name": "atUserName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelChatBiz.addFriendChannelChat",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_chat_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-chat/add-group-channel-chat",
"subPath": "/add-group-channel-chat",
"description": "发送多人频道聊天",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "message",
"source": "body",
"required": false
},
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "atUserId",
"source": "body",
"required": true
},
{
"name": "atUserName",
"source": "body",
"required": true
},
{
"name": "isAtAll",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelChatBiz.addGroupChannelChat",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_chat_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-chat/add-reply-friend-channel-chat",
"subPath": "/add-reply-friend-channel-chat",
"description": "回复好友聊天",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "message",
"source": "body",
"required": false
},
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "messageId",
"source": "body",
"required": true
},
{
"name": "messageType",
"source": "body",
"required": true
},
{
"name": "atUserId",
"source": "body",
"required": true
},
{
"name": "atUserName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelChatBiz.addReplyFriendChannelChat",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_chat_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-chat/add-reply-group-channel-chat",
"subPath": "/add-reply-group-channel-chat",
"description": "回复群组聊天",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "message",
"source": "body",
"required": false
},
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "messageId",
"source": "body",
"required": true
},
{
"name": "messageType",
"source": "body",
"required": true
},
{
"name": "atUserId",
"source": "body",
"required": true
},
{
"name": "atUserName",
"source": "body",
"required": true
},
{
"name": "atAll",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelChatBiz.addReplyGroupChannelChat",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_file_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-file/add-friend-channel-offline-file",
"subPath": "/add-friend-channel-offline-file",
"description": "发送好友频道离线文件消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "cloudFileId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelFileBiz.addFriendChannelOfflineFile",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_file_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-file/add-group-channel-offline-file",
"subPath": "/add-group-channel-offline-file",
"description": "发送群聊频道离线文件消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "cloudFileId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelFileBiz.addGroupChannelOfflineFile",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_media_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-media/add-friend-channel-audio",
"subPath": "/add-friend-channel-audio",
"description": "发送好友频道语音聊天消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelMediaBiz.addFriendChannelAudio",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_media_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-media/add-friend-channel-video",
"subPath": "/add-friend-channel-video",
"description": "发送好友频道视频消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelMediaBiz.addFriendChannelVideo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_media_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-media/add-group-channel-audio",
"subPath": "/add-group-channel-audio",
"description": "发送多人频道语音聊天消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelMediaBiz.addGroupChannelAudio",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_media_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-media/add-group-channel-video",
"subPath": "/add-group-channel-video",
"description": "发送多人频道视频消息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelMediaBiz.addGroupChannelVideo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_notice_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-notice/add-channel-notice",
"subPath": "/add-channel-notice",
"description": "发布频道公告",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "content",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelNoticeBiz.addNotice",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_notice_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel-notice/get-channel-notice-list",
"subPath": "/get-channel-notice-list",
"description": "获取频道公告",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "channelId",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelNoticeBiz.getNoticeList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_user_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel-user/add-channel-user",
"subPath": "/get-channel-list-user-list",
"description": "添加频道用户",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelUserBiz.getChannelListUserList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_user_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-user/exit-channel",
"subPath": "/exit-channel",
"description": "退出频道",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelUserBiz.exitChannel",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_user_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel-user/get-channel-user-list",
"subPath": "/get-channel-user-list",
"description": "获取某个频道的用户列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "channelId",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelUserBiz.getChannelUserList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_user_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-user/update-channel-black",
"subPath": "/update-channel-black",
"description": "修改频道是否拉黑",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "black",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelUserBiz.updateChannelToBlack",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_user_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel-user/update-channel-top",
"subPath": "/update-channel-top",
"description": "修改频道是否置顶",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "top",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelUserBiz.updateChannelToTop",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/add-channel",
"subPath": "/add-channel",
"description": "添加频道",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.addChannel",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel/get-channel-info",
"subPath": "/get-channel-info",
"description": "获取频道信息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "channelId",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelInfo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel/get-channel-list",
"subPath": "/get-channel-list",
"description": "获取频道列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/get-channel-message",
"subPath": "/get-channel-message",
"description": "获取频道聊天记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "chatMinId",
"source": "body",
"required": true
},
{
"name": "fileMinId",
"source": "body",
"required": true
},
{
"name": "mediaMinId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelChatList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/get-channel-message-list",
"subPath": "/get-channel-message-list",
"description": "获取频道列表聊天记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelIdList",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelChatListByChannelIdList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/get-channel-name",
"subPath": "/get-channel-name",
"description": "获取频道名称",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelNameById",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "GET",
"path": "/api/web/channel/get-group-channel-list",
"subPath": "/get-group-channel-list",
"description": "获取群组频道列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.getChannelGroupList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/search-channel-by-id",
"subPath": "/search-channel-by-id",
"description": "根据频道id搜索频道",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "shareUserId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.searchChannelById",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/search-channel-message",
"subPath": "/search-channel-message",
"description": "搜索频道聊天记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "keyword",
"source": "body",
"required": true
},
{
"name": "startTime",
"source": "body",
"required": true
},
{
"name": "endTime",
"source": "body",
"required": true
},
{
"name": "types",
"source": "body",
"required": true
},
{
"name": "chatMinId",
"source": "body",
"required": true
},
{
"name": "fileMinId",
"source": "body",
"required": true
},
{
"name": "mediaMinId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.searchChannelChatList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/update-channel-can-search",
"subPath": "/update-channel-can-search",
"description": "修改频道是否可以被搜索",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "canSearch",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.updateChannelCanSearch",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/channel/channel_controller.js",
"module": "channel",
"method": "POST",
"path": "/api/web/channel/update-channel-name",
"subPath": "/update-channel-name",
"description": "修改频道名称",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "channelName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.updateChannelName",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cloud/cloud_file_controller.js",
"module": "cloud",
"method": "GET",
"path": "/api/web/cloud-file/download-server-file",
"subPath": "/download-server-file",
"description": "下载服务器云文件",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "fileId",
"source": "query",
"required": true
},
{
"name": "key",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cloudFileBiz.downloadCloudFile",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cloud/cloud_file_controller.js",
"module": "cloud",
"method": "POST",
"path": "/api/web/cloud-file/upload-file",
"subPath": "/upload-file",
"description": "上传文件",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "dirId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cloudFileBiz.uploadFile",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/company/company_controller.js",
"module": "company",
"method": "POST",
"path": "/api/web/company/get-company",
"subPath": "/get-company",
"description": "获取企业信息",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.getCompanyInfo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_share_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste-share/share-add-cut-paste-detail",
"subPath": "/share-add-cut-paste-detail",
"description": "通过分享渠道新增剪切板详情",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "content",
"source": "body",
"required": false
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.addCutPasteDetailByCode",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_share_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste-share/share-get-cut-paste-list",
"subPath": "/share-get-cut-paste-list",
"description": "通过分享渠道获取剪切板列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "typeList",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.getCutPasteDetailListByCode",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/add-cut-paste",
"subPath": "/add-cut-paste",
"description": "新增剪切板",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "title",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.createCutPaste",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/add-cut-paste-detail",
"subPath": "/add-cut-paste-detail",
"description": "新增剪切板详情",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
},
{
"name": "content",
"source": "body",
"required": false
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.addCutPasteDetail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/close-cut-paste",
"subPath": "/close-cut-paste",
"description": "关闭剪切板",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.closeCutPaste",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/delete-cut-paste",
"subPath": "/delete-cut-paste",
"description": "删除剪切板",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.deleteCutPaste",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/delete-cut-paste-detail",
"subPath": "/delete-cut-paste-detail",
"description": "删除剪切板详情",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteDetailId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.deleteCutPasteDetail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/get-cut-paste-detail-list",
"subPath": "/get-cut-paste-detail-list",
"description": "获取剪切板详情列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
},
{
"name": "typeList",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.getCutPasteDetailList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "GET",
"path": "/api/web/cut-paste/get-cut-paste-list",
"subPath": "/get-cut-paste-list",
"description": "获取剪切板列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.getCutPasteList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/open-cut-paste",
"subPath": "/open-cut-paste",
"description": "开启剪切板",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.openCutPaste",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/update-cut-paste-password",
"subPath": "/update-cut-paste-password",
"description": "更新剪切板密码",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.updateCutPastePassword",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/cut_paste/cut_paste_controller.js",
"module": "cut_paste",
"method": "POST",
"path": "/api/web/cut-paste/update-cut-paste-title",
"subPath": "/update-cut-paste-title",
"description": "更新剪切板标题",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cutPasteId",
"source": "body",
"required": true
},
{
"name": "title",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "cutPasteBiz.updateCutPasteTitle",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_channel_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-channel/add-channel",
"subPath": "/add-channel",
"description": "添加频道",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelName",
"source": "body",
"required": true
},
{
"name": "companyId",
"source": "body",
"required": true
},
{
"name": "userId",
"source": "body",
"required": true
},
{
"name": "canSearch",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.adminAddChannel",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_channel_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-channel/delete-channel",
"subPath": "/delete-channel",
"description": "删除频道",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "companyId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.adminDeleteChannel",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_channel_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-channel/get-channel-list",
"subPath": "/get-channel-list",
"description": "获取频道列表",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "keyword",
"source": "query",
"required": true
},
{
"name": "page",
"source": "query",
"required": true
},
{
"name": "limit",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.adminGetChannelList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_channel_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-channel/get-channel-user-list",
"subPath": "/get-channel-user-list",
"description": "获取频道用户列表",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "keyword",
"source": "query",
"required": true
},
{
"name": "page",
"source": "query",
"required": true
},
{
"name": "limit",
"source": "query",
"required": true
},
{
"name": "channelId",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.adminGetChannelUserList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_channel_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-channel/update-channel",
"subPath": "/update-channel",
"description": "更新频道",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "companyId",
"source": "body",
"required": true
},
{
"name": "channelName",
"source": "body",
"required": true
},
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "canSearch",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "channelBiz.adminUpdateChannel",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_company_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-company/add-company",
"subPath": "/add-company",
"description": "添加企业",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "name",
"source": "body",
"required": true
},
{
"name": "address",
"source": "body",
"required": true
},
{
"name": "phone",
"source": "body",
"required": true
},
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "website",
"source": "body",
"required": true
},
{
"name": "logo",
"source": "body",
"required": true
},
{
"name": "description",
"source": "body",
"required": true
},
{
"name": "openRegister",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.adminAddCompany",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_company_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-company/delete-company",
"subPath": "/delete-company",
"description": "删除企业",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.adminDeleteCompany",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_company_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-company/get-company-info",
"subPath": "/get-company-info",
"description": "获取企业详情",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "id",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.adminGetCompanyInfo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_company_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-company/get-company-list",
"subPath": "/get-company-list",
"description": "获取企业列表",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "page",
"source": "query",
"required": true
},
{
"name": "limit",
"source": "query",
"required": true
},
{
"name": "keyword",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.adminGetCompanyList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_company_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-company/update-company",
"subPath": "/update-company",
"description": "更新企业信息",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "name",
"source": "body",
"required": true
},
{
"name": "address",
"source": "body",
"required": true
},
{
"name": "phone",
"source": "body",
"required": true
},
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "website",
"source": "body",
"required": true
},
{
"name": "logo",
"source": "body",
"required": true
},
{
"name": "description",
"source": "body",
"required": true
},
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "authStatus",
"source": "body",
"required": true
},
{
"name": "expiredStatus",
"source": "body",
"required": true
},
{
"name": "openRegister",
"source": "body",
"required": false
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "companyBiz.adminUpdateCompany",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_config_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-config/get-system-config",
"subPath": "/get-system-config",
"description": "获取系统配置",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "configBiz.adminGetSystemEnvConfig",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_config_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-config/update-system-config",
"subPath": "/update-system-config",
"description": "修改系统配置",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "redisConfig",
"source": "body",
"required": true
},
{
"name": "webrtcConfig",
"source": "body",
"required": true
},
{
"name": "mysqlConfig",
"source": "body",
"required": true
},
{
"name": "emailConfig",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "configBiz.adminSetSystemEnvConfig",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_service_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-service/get-service-status",
"subPath": "/get-service-status",
"description": "获取服务状态",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "systemServiceBiz.adminGetServiceStatus",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_service_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-service/restart-service",
"subPath": "/restart-service",
"description": "重启服务",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "serviceName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "systemServiceBiz.adminReadminStartPm2Service",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_service_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-service/start-service",
"subPath": "/start-service",
"description": "启动服务",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "serviceName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "systemServiceBiz.adminStartPm2Service",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_service_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-service/stop-service",
"subPath": "/stop-service",
"description": "停止服务服务",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "serviceName",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "systemServiceBiz.adminStopPm2Service",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_user_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-user/add-user",
"subPath": "/add-user",
"description": "添加用户",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "companyId",
"source": "body",
"required": true
},
{
"name": "name",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
},
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "mobile",
"source": "body",
"required": true
},
{
"name": "avatarUrl",
"source": "body",
"required": true
},
{
"name": "roleId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.adminAddUser",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_user_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-user/delete-user",
"subPath": "/delete-user",
"description": "删除用户",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "companyId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.adminDeleteUser",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_user_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-user/get-user-info",
"subPath": "/get-user-info",
"description": "获取用户信息",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "companyId",
"source": "query",
"required": true
},
{
"name": "id",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.adminGetUserInfo",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_user_controller.js",
"module": "system",
"method": "GET",
"path": "/api/web/system-web-user/get-user-list",
"subPath": "/get-user-list",
"description": "获取用户列表",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "keyword",
"source": "query",
"required": true
},
{
"name": "page",
"source": "query",
"required": true
},
{
"name": "limit",
"source": "query",
"required": true
},
{
"name": "companyId",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.adminGetUserList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/system/system_web_user_controller.js",
"module": "system",
"method": "POST",
"path": "/api/web/system-web-user/update-user",
"subPath": "/update-user",
"description": "更新用户",
"service": "super-api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "companyId",
"source": "body",
"required": true
},
{
"name": "name",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
},
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "mobile",
"source": "body",
"required": true
},
{
"name": "avatarUrl",
"source": "body",
"required": true
},
{
"name": "roleId",
"source": "body",
"required": true
},
{
"name": "wchatName",
"source": "body",
"required": true
},
{
"name": "wchatOpenId",
"source": "body",
"required": true
},
{
"name": "wchatUnionId",
"source": "body",
"required": true
},
{
"name": "wchatAvatarUrl",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.adminUpdateUser",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/add-user-friend-apply",
"subPath": "/add-user-friend-apply",
"description": "添加好友申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "friendId",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.applyAddFriend",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/add-user-group-apply",
"subPath": "/add-user-group-apply",
"description": "添加群聊申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
},
{
"name": "shareUserId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.applyAddGroup",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-apply/get-user-friend-other-apply-list",
"subPath": "/get-user-friend-other-apply-list",
"description": "获取自己收到的用户好友申请列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.getUserFriendListFromOther",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-apply/get-user-friend-self-apply-list",
"subPath": "/get-user-friend-self-apply-list",
"description": "获取自己发出的用户好友申请列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.getUserFriendApplyListFromSelf",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-apply/get-user-group-other-apply-list",
"subPath": "/get-user-group-other-apply-list",
"description": "获取自己收到的群聊申请列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.getUserGroupListFromOther",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-apply/get-user-group-self-apply-list",
"subPath": "/get-user-group-self-apply-list",
"description": "获取自己发出的群聊申请列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.getUserGroupApplyListFromSelf",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/pass-user-friend",
"subPath": "/pass-user-friend",
"description": "通过好友申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.passUserFriendApply",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/pass-user-group",
"subPath": "/pass-user-group",
"description": "通过群聊申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.passUserGroupApply",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/reject-user-friend",
"subPath": "/reject-user-friend",
"description": "拒绝好友申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.rejectUserFriendApply",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_apply_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-apply/reject-user-group",
"subPath": "/reject-user-group",
"description": "拒绝群聊申请",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userApplyBiz.rejectUserGroupApply",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_clear_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-clear/update-channel-chat-clear",
"subPath": "/update-channel-chat-read",
"description": "更新频道聊天消息清理记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userClearBiz.updateChannelChatClear",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_clear_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-clear/update-channel-file-clear",
"subPath": "/update-channel-file-clear",
"description": "更新频道文件消息清理记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userClearBiz.updateChannelFileClear",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_clear_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-clear/update-channel-media-clear",
"subPath": "/update-channel-media-clear",
"description": "更新频道媒体消息清理记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userClearBiz.updateChannelMediaClear",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_clear_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-clear/update-channel-mutil-clear",
"subPath": "/update-channel-mutil-clear",
"description": "更新频道文件/媒体/聊天消息清理记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userClearBiz.updateChannelMuiltClear",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-config/get-user-config",
"subPath": "/get-user-config",
"description": "获取用户配置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.getUserConfigSetting",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-config/update-user-config-account",
"subPath": "/update-user-config-account",
"description": "更新用户账号设置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "account",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.updateUserConfigAccount",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-config/update-user-config-message",
"subPath": "/update-user-config-message",
"description": "更新用户消息设置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "message",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.updateUserConfigMessage",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-config/update-user-config-normal",
"subPath": "/update-user-config-normal",
"description": "更新用户通用设置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "normal",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.updateUserConfigNormal",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-config/update-user-config-other",
"subPath": "/update-user-config-other",
"description": "更新用户其他设置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "other",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.updateUserConfigOther",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_config_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-config/update-user-config-skin",
"subPath": "/update-user-config-skin",
"description": "更新用户皮肤设置",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "skin",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userConfigBiz.updateUserConfigSkin",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_friend_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-friend/delete-user-friend",
"subPath": "/delete-user-friend",
"description": "删除好友",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userFriendBiz.deleteFriend",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_friend_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-friend/get-user-friend-list",
"subPath": "/get-user-friend-list",
"description": "获取用户好友列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userFriendBiz.getFriendList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_friend_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-friend/update-user-friend-remark",
"subPath": "/update-user-friend-remark",
"description": "更新好友信息备注",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "remark",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userFriendBiz.updateRemark",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_friend_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-friend/update-user-friend-rename",
"subPath": "/update-user-friend-rename",
"description": "更新好友名称备注",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "rename",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userFriendBiz.updateRename",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-login/login-by-account",
"subPath": "/login-by-account",
"description": "通过账号登录",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "account",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
},
{
"name": "fps",
"source": "body",
"required": true
},
{
"name": "inviteCode",
"source": "body",
"required": true
}
],
"setsCookies": [
"LOGIN_TOKEN_KEY"
]
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginBiz.userLoginByAccount",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-login/login-by-email",
"subPath": "/login-by-email",
"description": "通过邮箱登录",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
},
{
"name": "fps",
"source": "body",
"required": true
},
{
"name": "inviteCode",
"source": "body",
"required": true
}
],
"setsCookies": [
"LOGIN_TOKEN_KEY"
]
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginBiz.userLoginByEmail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-login/login-by-fp",
"subPath": "/login-by-fp",
"description": "通过指纹一键登录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "username",
"source": "body",
"required": true
},
{
"name": "fps",
"source": "body",
"required": true
},
{
"name": "inviteCode",
"source": "body",
"required": true
}
],
"setsCookies": [
"LOGIN_TOKEN_KEY"
]
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginBiz.userLoginByFingerPrint",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-login/login-by-system",
"subPath": "/login-by-system",
"description": "管理员登录",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": [
"SYSTEM_LOGIN_TOKEN_KEY"
]
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginBiz.userLoginBySystem",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-login/login-state",
"subPath": "/login-state",
"description": "获取登录状态",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginStateBiz.userIsLogin",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_login_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-login/system-login-state",
"subPath": "/system-login-state",
"description": "获取管理员登录状态",
"service": "super-api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLoginStateBiz.userIsLogin",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_logout_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-logout/logout",
"subPath": "/logout",
"description": "退出登录",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLogoutBiz.userLogout",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_logout_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-logout/system-logout",
"subPath": "/system-logout",
"description": "退出登录",
"service": "super-api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "system-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userLogoutBiz.userLogout",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-channel-chat-read",
"subPath": "/update-channel-chat-read",
"description": "更新频道聊天消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "latestReadId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.updateChannelChatRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-channel-file-read",
"subPath": "/update-channel-file-read",
"description": "更新频道文件消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "latestReadId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.updateChannelFileRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-channel-media-read",
"subPath": "/update-channel-media-read",
"description": "更新频道媒体消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "latestReadId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.updateChannelMediaRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-channel-mutil-read",
"subPath": "/update-channel-mutil-read",
"description": "更新频道文件/媒体/聊天消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "channelId",
"source": "body",
"required": true
},
{
"name": "latestChatReadId",
"source": "body",
"required": true
},
{
"name": "latestMediaReadId",
"source": "body",
"required": true
},
{
"name": "latestFileReadId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.updateChannelMuiltRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-friend-apply-pass-read",
"subPath": "/update-user-friend-apply-pass-read",
"description": "新增通过好友申请消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "recordId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserFriendApplyPassRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-friend-apply-read",
"subPath": "/update-user-friend-apply-read",
"description": "新增好友申请消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "recordId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserFriendApplyRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-friend-apply-reject-read",
"subPath": "/update-user-friend-apply-reject-read",
"description": "新增拒绝好友申请消息已读记录",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "applyId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserFriendApplyRejectRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-group-apply-pass-read",
"subPath": "/update-user-group-apply-pass-read",
"description": "",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "recordId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserGroupApplyPassRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-group-apply-read",
"subPath": "/update-user-group-apply-read",
"description": "",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "recordId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserGroupApplyRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_read_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-read/update-user-group-apply-reject-read",
"subPath": "/update-user-group-apply-reject-read",
"description": "",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "recordId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userReadBiz.addUserGroupApplyRejectRead",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_register_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-register/get-email-code",
"subPath": "/get-email-code",
"description": "获取邮箱验证码",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "email",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "bizUserRegister.getEmailCode",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_register_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-register/register-by-account",
"subPath": "/register-by-account",
"description": "通过账号注册",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "account",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
},
{
"name": "invite_code",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "bizUserRegister.userRegisterByAccount",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_register_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-register/register-by-email",
"subPath": "/register-by-email",
"description": "通过邮箱注册",
"service": "api",
"auth": {
"loginRequired": false,
"roleCheckRequired": false,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "invite_code",
"source": "body",
"required": true
},
{
"name": "password",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "bizUserRegister.userRegisterByEmail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_register_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-register/reset-by-email",
"subPath": "/reset-by-email",
"description": "重置邮箱用户密码",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "code",
"source": "body",
"required": true
},
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "invite_code",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "bizUserRegister.resetPasswordByEmail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-tag/add-channel-tag",
"subPath": "/add-channel-tag",
"description": "添加频道标签",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "name",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.addChannelTag",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-tag/add-cloud-tag",
"subPath": "/add-cloud-tag",
"description": "添加云资源库标签",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "name",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.addCloudTag",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-tag/add-friend-tag",
"subPath": "/add-friend-tag",
"description": "添加好友标签",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "name",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.addFriendTag",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user-tag/delete-tag",
"subPath": "/delete-tag",
"description": "删除标签",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.delUserTag",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-tag/get-channel-tag-list",
"subPath": "/get-channel-tag-list",
"description": "获取频道标签列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.getChannelTagList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-tag/get-cloud-tag-list",
"subPath": "/get-cloud-tag-list",
"description": "获取云资源库标签列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.getCloudTagList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_tag_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user-tag/get-friend-tag-list",
"subPath": "/get-friend-tag-list",
"description": "获取好友标签列表",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "none",
"params": [],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userTagBiz.getFriendTagList",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user/bind-email",
"subPath": "/bind-email",
"description": "绑定邮箱",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "email",
"source": "body",
"required": true
},
{
"name": "code",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.bindEmail",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user/search-user-by-id",
"subPath": "/search-user-by-id",
"description": "搜索用户通过id",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "id",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.searchUserById",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_controller.js",
"module": "user",
"method": "GET",
"path": "/api/web/user/search-user-by-name",
"subPath": "/search-user-by-name",
"description": "搜索用户",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "query",
"params": [
{
"name": "name",
"source": "query",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.searchUserByName",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
},
{
"controllerFile": "src/controller/web/user/user_controller.js",
"module": "user",
"method": "POST",
"path": "/api/web/user/update-user-avatar",
"subPath": "/update-user-avatar",
"description": "更新用户头像",
"service": "api",
"auth": {
"loginRequired": true,
"roleCheckRequired": true,
"tokenType": "user-cookie-or-header"
},
"request": {
"paramSource": "body",
"params": [
{
"name": "cloudFileId",
"source": "body",
"required": true
}
],
"setsCookies": []
},
"response": {
"envelope": {
"success": "boolean",
"code": "number",
"msg": "string",
"data": "object|array|string|number|boolean"
},
"businessResult": "userBiz.updateUserAvatar",
"commonErrorCodes": [
400,
403,
404,
500,
504
]
}
}
]
}