github_mirrors/websoft9
1
0
Fork 0
mirror of https://github.com/Websoft9/websoft9.git synced 2025-01-24 10:17:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update developer.md

Browse Source
This commit is contained in:
qiaofeng1227 2023-04-10 15:45:41 +08:00 committed by GitHub
parent 36d5ac4c5a
commit 09944774b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
appmanage/docs/developer.md
View File

@ -45,6 +45,48 @@
各个业务接口的详细说明，公共参数不在这里继续说明。
### app 安装接口
#### 请求URL
请求URL=FastAPI通用URL/AppInstall
#### 请求参数
| 参数名称 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
| app_name | 应用名称 | string |必须 |
| customer_app_name | 用户自定义应用名称 | string |必须 |
| app_version | 应用版本 | string |必须 |
#### 返回结果
| 返回值 | 用途 |类型 |必要性 |
| ------ | --------------------------------------------- | ------ |------ |
| ResponseData || AppID |必须 |
| error || ErrorInfo |非必须 |
AppID 说明:
```
{
  app_id：应用ID
  
}
```
ErrorInfo 说明:
| code |message |
| --------------------------------------------- | ------ |
| Param.App_name.Blank | APP名称为空 |
| Param.CustomerAppName.Blank | 用户自定义APP名称为空 |
| Param.CustomerAppName.NotExis | 不支持安装指定的App |
| Param.CustomerAppName.FormatError | 查询的APP_ID只能是数字和小写字母组成 |
| Param.CustomerAppName.Repeat | 已经安装了此应用，请重新指定APP名称 |
| Param.CustomerAppName.Wait | 同名应用已经在安装等待中，请重新指定APP名称 |
| Requirement.NotEnough| 系统资源（cpu，内存，磁盘空间）不足 |
| ContainerCommandError | 操作容器指令发生错误 |
| SystemError |系统异常，请联系管理员（系统报错返回） |
### app 状态查询接口
#### 请求URL