bytefun
Version:
一个打通了原型设计、UI设计与代码转换、跨平台原生代码开发等的平台
233 lines (227 loc) • 7.03 kB
Markdown
# globalApiInterfaceList
## api接口列表
### 1、账号模块
| 接口名称 | 方法 | URL | 描述 | 认证 | 备注 |
| -------------- | ----- | ------------------- | -------------------- | ------- | --------------- |
| 发送短信验证码 | POST | '/client/biz/auth/send/code' | 发送短信验证码给客户端 | JWT | 无 |
### 2、xxx模块
（添加该模块的接口列表说明表格）
## 接口JSON列表
```json
[
{
"moduleEnName": "bytefun-boot-biz-internal",
"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": "响应"
}
},
{
"moduleEnName": "bytefun-boot-biz-internal",
"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": "响应"
}
},
{
"moduleEnName": "bytefun-boot-biz-internal",
"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": "响应"
}
},
{
"moduleEnName": "bytefun-boot-biz-internal",
"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": "响应"
}
},
{
"moduleEnName": "bytefun-boot-biz-internal",
"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": "响应"
}
}
]
```