This commit is contained in:
yanweidong 2024-10-04 13:17:08 +08:00
parent cfbf2328ce
commit e05234962c
1 changed files with 279 additions and 0 deletions

View File

@ -83,3 +83,282 @@ Telemetry:
bsm start/restart/update initialize
```
## API 接口说明
## POST 检测是否有新版或新的配置
POST /initialize.Check.Updates
> Body 请求参数
```json
{
"app": "ut occaecat sit Duis proident",
"os": "consequat laborum velit reprehenderit",
"arch": "exercitation sit reprehenderit in amet",
"version": "minim ullamco"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Request-Id|header|string| 是 ||请求ID|
|Content-Type|header|string| 是 ||传输格式|
|Workspace|header|string| 是 ||项目名称|
|Authorization|header|string| 否 ||用户通行证Token|
|body|body|object| 否 ||none|
|» app|body|string| 是 | 应用程序名称 <必填>|应用程序名称|
|» os|body|string| 是 | 操作系统 <必填>|操作系统|
|» arch|body|string| 是 | 构架名称 <必填>|构架名称|
|» version|body|string| 是 | 版本号 <必填>|版本号|
> 返回示例
> 200 Response
```json
{
"identity": "string",
"version": "string",
"summary": "string",
"files": "string",
"pubdate": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» identity|string|true|none|唯一标识|0为未找到相应版本|
|» version|string|true|none|版本号|0为未找到相应版本|
|» summary|string|true|none||none|
|» files|string|true|none||none|
|» pubdate|string|true|none||none|
## POST 获取应用的相关配置信息
POST /initialize.Data.Configure
> Body 请求参数
```json
{
"app": "milu",
"os": "windows"
}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Content-Type|header|string| 是 ||none|
|Request-Id|header|string| 是 ||请求ID|
|Workspace|header|string| 是 ||项目名称|
|Authorization|header|string| 否 ||用户通行证Token|
|body|body|object| 否 ||none|
|» app|body|string| 是 | 应用程序名称 <必填>|应用程序名称|
|» os|body|string| 是 | 操作系统 <必填>|操作系统|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### 返回数据结构
状态码 **200**
*empty object*
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
## POST 获取系统区域数据
POST /initialize.Data.Areas
> Body 请求参数
```json
{}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Content-Type|header|string| 是 ||none|
|Request-Id|header|string| 是 ||请求ID|
|Workspace|header|string| 是 ||项目名称|
|Authorization|header|string| 否 ||用户通行证Token|
|body|body|object| 否 ||none|
|» is_town|body|boolean| 否 ||是否列出乡镇数据,【开关】|
> 返回示例
> 200 Response
```json
{
"areas": [
{
"id": "string",
"pid": "string",
"deep": 0,
"name": "string",
"pinyinPrefix": "string",
"pinyin": "string",
"extId": "string",
"extName": "string"
}
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### 返回数据结构
状态码 **200**
*empty object*
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» areas|[object]|true|none||区域数据数组|
|»» id|string|true|none||none|
|»» pid|string|true|none||none|
|»» deep|integer|true|none||none|
|»» name|string|true|none||none|
|»» pinyinPrefix|string|true|none||none|
|»» pinyin|string|true|none||none|
|»» extId|string|true|none||none|
|»» extName|string|true|none||none|
## POST 获取系统标签数据
POST /initialize.Data.Tags
> Body 请求参数
```json
{}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Content-Type|header|string| 是 ||none|
|Request-Id|header|string| 是 ||请求ID|
|Workspace|header|string| 是 ||项目名称|
|Authorization|header|string| 否 ||用户通行证Token|
|body|body|object| 否 ||none|
> 返回示例
> 200 Response
```json
{
"tags": [
"string"
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### 返回数据结构
状态码 **200**
*empty object*
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» tags|[string]|true|none||标签数据数组|
## POST hello
POST /initialize.Check.Hello
> Body 请求参数
```json
{}
```
### 请求参数
|名称|位置|类型|必选|中文名|说明|
|---|---|---|---|---|---|
|Request-Id|header|string| 是 ||请求ID|
|Content-Type|header|string| 是 ||传输格式|
|Workspace|header|string| 是 ||项目名称|
|Authorization|header|string| 否 ||用户通行证Token|
|body|body|object| 否 ||none|
> 返回示例
> 200 Response
```json
{
"Code": 0,
"Data": {
"identity": "string",
"status": "string",
"message": "string",
"timeseq": "string"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### 返回数据结构
状态码 **200**
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|» Code|integer|true|none||none|
|» Data|object|true|none||none|
|»» identity|string|true|none||none|
|»» status|string|true|none||none|
|»» message|string|true|none||none|
|»» timeseq|string|true|none||none|