test

docs/PRD.md

@@ -1,7 +1,7 @@
 # 概述
 
 StackHub主要架构和技术选型如下：
-架构：后台JS框架+后端Python提供API服务
+架构：后台JS框架+后端Python提供API服务  
 后端：Python, Docker, Docker-compose, FastAPI, Typer
 
 ## 后端接口说明
@@ -15,6 +15,7 @@ http://ip:port/installApp
 #### 访问方式
 
 Http（get/post）
+同步/异步：异步
 
 
 #### 接口参数
@@ -23,9 +24,68 @@ Http（get/post）
 | ------------ | ------------ | ----- |----- |
 | appName       | 安装app的名称|  str  |可选  |
 
+e.g.
+{
+    "appName":"redmine"
+}
+
 #### 返回数据
 
 | 变量名       | 说明       | 类型  | 备注  |
 | ------------ | ------------ | ----- |----- |
 | code       | 接口是否调用成功标志|  str  |"0":失败 "1":成功   |
-| message       | 接口返回信息|  str  |如接口调用成功时返回"appName 安装成功"  |
+| message       | 接口返回信息|  str  |如接口调用成功时返回"appName安装成功"  |
+| data       | APP相关信息|  Json  |主容器名： websoft9-appName App端口: port(9001) |
+
+e.g.  
+{
+    "code":"1",
+    "message":"appName安装成功",
+    "data":{
+        "containerName": "websoft9-appName",
+        "port": "9001",
+        "db_port": "3307",
+        "info": "XXXX"
+    }
+}
+
+#### 接口主要内容
+
+通过调用该接口，判断服务器是否已经存在websoft9-appName容器，如存在返回失败信息，并提示已经存在该App；如不存在，在服务器端启动一个名为websoft9-appName的容器以及相关容器，主容器以及相关容器的端口需要根据服务器状态动态设定。
+
+
+
+### App卸载接口（uninstallApp）
+
+#### 接口地址
+
+http://ip:port/uninstallApp
+
+#### 访问方式
+
+Http（get/post）
+同步/异步：同步
+
+#### 接口参数
+
+| 变量名       | 说明       | 类型  | 备注  |
+| ------------ | ------------ | ----- |----- |
+| appName       | 卸载app的名称|  str  |可选  |
+
+e.g.
+{
+    "appName":"redmine"
+}
+
+#### 返回数据
+
+| 变量名       | 说明       | 类型  | 备注  |
+| ------------ | ------------ | ----- |----- |
+| code       | 接口是否调用成功标志|  str  |"0":失败 "1":成功   |
+| message       | 接口返回信息|  str  |如接口调用成功时返回"appName卸载成功"  |
+
+e.g.  
+{
+    "code":"0",
+    "message":"appName卸载失败，任然在运行，端口为9001，请ssh登陆如服务器后使用docker-ps查看，并手动停止容器"
+}