docs(web-api): 设计交互协议

Signed-off-by: YdrMaster <[email protected]>
InfiniTensor · Apr 17, 2024 · b9231c7 · b9231c7
1 parent 78d99ed
commit b9231c7
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/web-api/README.md b/web-api/README.md
@@ -0,0 +1,23 @@
+# web 服务
+
+实现 web 服务，提供 RESTful API 接口。
+
+```json
+{
+    "/infer": {
+        "session_id": "String",
+        "inputs": [{
+            "role": "String",
+            "content": "String"
+        }],
+        "dialog_pos": "int"
+    },
+    "/fork": {
+        "session_id": "String",
+        "new_session_id": "String"
+    },
+    "/drop": {
+        "session_id": "String"
+    }
+}
+```
diff --git a/web-api/src/lib.rs b/web-api/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 mod handlers;
 mod manager;
 mod response;