bytefun
Version:
一个打通了原型设计、UI设计与代码转换、跨平台原生代码开发等的平台
608 lines • 26.2 kB
JSON
{
"projectName": "32号旅游",
"moduleList": [
{
"moduleFolder": "bytefun-boot-biz-internal",
"moduleEnName": "accountBizModule",
"moduleCnName": "账号系统业务模块11",
"description": "包括发送短信验证码、手机号登录、手机号注册、注销（退出）、账号密码登录业务服务",
"apiList": [
{
"apiEnName": "sendSmsCode",
"name": "发送短信验证码",
"method": "POST",
"path": "/client/biz/auth/send/code",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "mobile",
"type": "string",
"required": "true",
"description": "手机号"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "string",
"description": "响应数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "mobileLogin",
"name": "手机号登录",
"method": "POST",
"path": "/client/biz/auth/mobile",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "mobile",
"type": "string",
"required": "true",
"description": "手机号"
},
{
"name": "code",
"type": "string",
"required": "true",
"description": "验证码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "访问令牌"
}
},
"description": "登录返回数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "mobileSignUp",
"name": "手机号注册",
"method": "POST",
"path": "/client/biz/auth/mobile/signUp",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "mobile",
"type": "string",
"required": "true",
"description": "手机号"
},
{
"name": "code",
"type": "string",
"required": "true",
"description": "验证码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "访问令牌"
}
},
"description": "注册返回数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "logout",
"name": "注销（退出）",
"method": "POST",
"path": "/client/biz/auth/logout",
"auth": "true",
"headers": {
"Content-Type": "application/json"
},
"parameters": [],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "string",
"description": "响应数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "login",
"name": "账号密码登录",
"method": "POST",
"path": "/client/biz/auth/login",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "username",
"type": "string",
"required": "true",
"description": "用户名"
},
{
"name": "password",
"type": "string",
"required": "true",
"description": "密码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "访问令牌"
}
},
"description": "登录返回数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "resetPassword",
"name": "重置密码",
"method": "POST",
"path": "/client/biz/auth/reset/password",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "mobile",
"type": "string",
"required": "true",
"description": "手机号"
},
{
"name": "code",
"type": "string",
"required": "true",
"description": "验证码"
},
{
"name": "newPassword",
"type": "string",
"required": "true",
"description": "新密码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "string",
"description": "响应数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "changePassword",
"name": "修改密码",
"method": "POST",
"path": "/client/biz/auth/change/password",
"auth": "true",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "oldPassword",
"type": "string",
"required": "true",
"description": "原密码"
},
{
"name": "newPassword",
"type": "string",
"required": "true",
"description": "新密码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "string",
"description": "响应数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "deleteAccount",
"name": "账号注销",
"method": "POST",
"path": "/client/biz/auth/delete/account",
"auth": "true",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "password",
"type": "string",
"required": "true",
"description": "密码确认"
},
{
"name": "reason",
"type": "integer",
"required": "true",
"description": "注销原因（1=不再使用，2=隐私担忧，3=功能不满意，4=其他）"
},
{
"name": "reasonText",
"type": "string",
"required": "false",
"description": "详细原因说明"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "string",
"description": "响应数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "getUserAgreement",
"name": "获取用户协议",
"method": "GET",
"path": "/client/biz/agreement/user",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "协议标题"
},
"content": {
"type": "string",
"description": "协议内容"
},
"version": {
"type": "string",
"description": "版本号"
}
},
"description": "协议数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "getPrivacyPolicy",
"name": "获取隐私协议",
"method": "GET",
"path": "/client/biz/agreement/privacy",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "协议标题"
},
"content": {
"type": "string",
"description": "协议内容"
},
"version": {
"type": "string",
"description": "版本号"
}
},
"description": "协议数据"
}
},
"description": "响应"
}
},
{
"apiEnName": "getHelpDocuments",
"name": "获取帮助文档列表",
"method": "GET",
"path": "/client/biz/help/documents",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "categoryId",
"type": "integer",
"required": "false",
"description": "分类ID，不传则获取所有"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "文档ID"
},
"title": {
"type": "string",
"description": "文档标题"
},
"content": {
"type": "string",
"description": "文档内容"
},
"categoryId": {
"type": "integer",
"description": "分类ID"
}
}
},
"description": "帮助文档列表"
}
},
"description": "响应"
}
},
{
"apiEnName": "searchHelpContent",
"name": "搜索帮助内容",
"method": "GET",
"path": "/client/biz/help/search",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "keyword",
"type": "string",
"required": "true",
"description": "搜索关键词"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "文档ID"
},
"title": {
"type": "string",
"description": "文档标题"
},
"content": {
"type": "string",
"description": "文档内容摘要"
}
}
},
"description": "搜索结果列表"
}
},
"description": "响应"
}
},
{
"apiEnName": "thirdPartyLogin",
"name": "第三方登录",
"method": "POST",
"path": "/client/biz/auth/third-party/login",
"auth": "false",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "platform",
"type": "string",
"required": "true",
"description": "平台类型（wechat/qq/weibo）"
},
{
"name": "code",
"type": "string",
"required": "true",
"description": "第三方平台授权码"
}
],
"responses": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "编码 0表示成功，其他值表示失败"
},
"msg": {
"type": "string",
"description": "消息内容"
},
"data": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "访问令牌"
},
"isNewUser": {
"type": "boolean",
"description": "是否为新用户"
}
},
"description": "登录返回数据"
}
},
"description": "响应"
}
}
]
}
]
}