websoft9/appmanage/docs/developer.md

70 lines
2.3 KiB
Markdown
Raw Normal View History

2023-04-10 13:46:02 +08:00
## API结构
2023-04-10 13:36:02 +08:00
2023-04-10 13:46:02 +08:00
### 请求
2023-04-10 13:54:34 +08:00
### 请求头(公共参数)
| 参数名称 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
2023-04-10 14:02:26 +08:00
| Version | appmanae接口版本 | string |必须 |
| Language | 接口显示语言 | string |必须 |
2023-04-10 13:54:34 +08:00
> 接口调用安全验证通过nginx
2023-04-10 14:02:26 +08:00
### 请求主体
2023-04-10 14:25:33 +08:00
[详细参照各个接口业务参数](#API接口说明)
2023-04-10 14:02:26 +08:00
### 响应结果
### 响应头(公共参数)
|返回参数 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
| HTTP状态码 | 判断接口调用是否成功200或404 | Integer |必须 |
### 响应主体
|返回参数 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
2023-04-10 14:21:54 +08:00
| error | 错误code和错误信息 | object | 非必须 ,无错误时不返回 |
2023-04-10 14:13:40 +08:00
| responseData | 各个接口的业务数据 | object |必须 |
2023-04-10 14:13:58 +08:00
2023-04-10 14:14:23 +08:00
```
2023-04-10 14:13:40 +08:00
{
"ResponseData": {
"Error": {
"Code": "AuthFailure.SignatureFailure",
"Message": "The provided credentials could not be validated. Please check your signature is correct."
}
}
2023-04-10 14:14:23 +08:00
```
2023-04-10 13:46:02 +08:00
2023-04-10 14:25:10 +08:00
## API接口说明
2023-04-10 14:24:13 +08:00
2023-04-10 14:31:01 +08:00
各个业务接口的详细说明,公共参数不在这里继续说明。
2023-04-10 14:24:13 +08:00
### app 列表查询接口
2023-04-10 14:31:01 +08:00
2023-04-10 14:51:42 +08:00
#### 请求URL
请求URL=FastAPI通用URL/AppsList
2023-04-10 14:31:01 +08:00
#### 请求参数
2023-04-10 14:27:39 +08:00
| 参数名称 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
| app_name | 查询app列表信息当app_name不为空时查询该app的信息 | string |非必须 |
2023-04-10 14:31:01 +08:00
#### 返回结果
| 返回值 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
2023-04-10 14:51:42 +08:00
| ResponseData || AppDetailInfo list |必须 |
2023-04-10 14:33:34 +08:00
| error || ErrorInfo |非必须 |
2023-04-10 14:51:42 +08:00
AppDetailInfo 说明:
ErrorInfo 说明:
| 接口名称 | code |message |
| ------ | --------------------------------------------- | ------ |
| AppsList | AppNotExist | 查询的APP不存在 |
| AppsList | SystemError |系统异常,请联系管理员 |