264 lines
6.8 KiB
JSON
264 lines
6.8 KiB
JSON
{
|
||
"generatedAt": "2026-05-06 17:09:32",
|
||
"generatedAtLocal": "2026-05-06 17:09:32",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "用户模块",
|
||
"key": "user",
|
||
"folder": "user",
|
||
"interfaceCount": 9
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "user.login",
|
||
"title": "用户登录(仅返回 token)",
|
||
"description": "用户登录(仅返回 token)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "password",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "password 参数"
|
||
},
|
||
{
|
||
"name": "username",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "username 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.loginByCode",
|
||
"title": "登录码登录(使用 ye4s_user.tmp_code)",
|
||
"description": "登录码登录(使用 ye4s_user.tmp_code)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "登录码,对应 ye4s_user.tmp_code"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.getLoginWechatCode",
|
||
"title": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)",
|
||
"description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "clientCode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "客户端编码;首次可不传,后续轮询建议透传已有值"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.getBindWechatCode",
|
||
"title": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)",
|
||
"description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "forceRefresh",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否强制刷新状态,true 时跳过缓存等待窗口"
|
||
},
|
||
{
|
||
"name": "waitForChange",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待"
|
||
},
|
||
{
|
||
"name": "longPoll",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "长轮询开关(兼容字段);true 时进入最长60秒等待"
|
||
},
|
||
{
|
||
"name": "waitTimeoutMs",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "等待超时毫秒数;后端自动封顶60000"
|
||
},
|
||
{
|
||
"name": "init",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"description": "初始化请求标记;true 时强制立即返回,不进入长等待"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.unbindWechat",
|
||
"title": "解绑微信账号(清理 ye4s 关联账号数据)",
|
||
"description": "解绑微信账号(清理 ye4s 关联账号数据)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.logout",
|
||
"title": "用户登出",
|
||
"description": "用户登出",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.info",
|
||
"title": "获取当前用户信息",
|
||
"description": "获取当前用户信息",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.changeRole",
|
||
"title": "user.changeRole 接口",
|
||
"description": "user.changeRole 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "user.register",
|
||
"title": "user.register 接口",
|
||
"description": "user.register 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
}
|
||
]
|
||
}
|