update:readme

2023-01-09 23:05:55 +08:00
parent c87e388ad3
commit 65fa3c9a7d
4 changed files with 87 additions and 63 deletions
@@ -52,15 +52,9 @@ docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --n
 ## 项目规划

 2022年12月14日
-
 这个项目的灵感来源于丁丁快传，然后写了这么一个基于本机存储的快传系统，本系统主要是以轻量，单用户，离线环境（`私有化`
 ）为主，因此也不需要加太多东西，所以其实这个项目到这基本功能已经完成了，剩下的就是维护和完善现有功能。
-
-也不会再加入新的大功能了，如果有新的功能的话，那就是我们的Pro版本了，当然也是继续开源的，能和@veoco一起开源挺荣幸的，在他的代码中我学到了许多，此前我基本上是使用Django那一套，对Fastapi仅限于使用，他的许多写法让我受益匪浅，也让我对Fastapi有了更深的了解，所以我也会在Pro版本中使用Fastapi。
-
-根据目前一些使用反馈来说，希望加入登录功能，还有多存储引擎等，欢迎各位继续提意见，加入我们共同开发。
-
-如果你有更好的想法和建议欢迎提issue。
+也不会再加入新的大功能了，如果你有更好的想法和建议欢迎提issue。

 ## 预览

@@ -166,6 +160,68 @@ KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文
 STORAGE_ENGINE=filesystem
 ```

+## 接口文档
+
+前端比较简陋，可以使用接口进行二次开发
+
+### 取件
+
+#### PATH
+
+`/`
+
+#### METHOD
+
+`POST`
+
+#### PARAMS
+
+code: 取件码
+
+#### Response
+
+```json
+{
+  "detail": "msg",
+  "data": {
+    "type": "类型",
+    "text": "文本",
+    "name": "名称",
+    "code": "取件码"
+  }
+}
+```
+
+### 寄件
+
+#### PATH
+
+`/share`
+
+#### METHOD
+
+`POST`
+
+#### PARAMS
+
+style: 1为次数，2为时间
+value: 次数或时间
+text: 取件码
+file: 文件
+
+#### Response
+
+```json
+{
+  "detail": "msg",
+  "data": {
+    "code": "类型",
+    "key": "唯一ID",
+    "name": "名称"
+  }
+}
+```
+
 ## 状态

 ![Alt](https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg "Repobeats analytics image")