接口
公共定义
根路径
| 服务类型 |
路径 |
说明 |
| 中心服务 |
/api/centeral |
|
| 应用服务 |
/api/\${SHORT_BUNDLE_ID} |
如果应用的 bundle id 是 com.nesp.movie, 则 api 根路径为 /api/movie |
安全
密码不允许明文传输。
Api 版本
通过在请求路径中添加版本号来控制版本，参考 api-version-managment-guide
~~通过 Content-Type 控制 api 版本。比如，application/vnd.company.v1+json 和application/vnd.company.v2+json。其中，company
为公司名称，v1 为 api 版本。~~
公共请求和响应
请求
请求头
| 字段 |
类型 |
说明 |
示例 |
| Accept-Language |
string |
国际化 |
|
| ~~Token~~ |
~~string~~ |
~~JWT Token~~ |
|
Authorization |
Bearer <token>
Basic dXNlcjpwYXNz |
凭证字符串 |
向服务端提供身份凭证。最常见的是 Bearer Token（JWT）和 Basic 认证。 |
| X-Sys |
string |
|
Android |
| X-Sys-Version-Code |
int |
Android: API Level |
0 |
| X-Sys-Version-Name |
string |
|
V1.2 |
| X-Sys-Arch |
string |
|
X86 |
| X-Platform-Id |
string |
|
|
| X-App-Id |
int |
|
|
| X-App-Version-Name |
string |
|
|
| X-App-Version-Code |
int |
|
|
| X-Device-Name |
string |
|
|
| X-Device-Model |
string |
|
|
| X-Device-Brand |
string |
|
|
| X-Device-Board |
string |
|
|
| X-Device-Id |
string |
|
|
响应
响应体
| 字段 |
类型 |
说明 |
示例 |
| code |
string |
|
000000 |
| msg |
string |
|
OK |
| data |
Object |
result of client |
{"id": 0} |
接口定义
OpenAPI
OpenAPI