update:readme

Author: vastsa

history.md

@@ -3,6 +3,7 @@
 import asyncio
 from pathlib import Path
 import os
+
 try:
     import chardet
     from fastapi import FastAPI, Depends, UploadFile, Form, File, HTTPException, BackgroundTasks
@@ -116,6 +117,25 @@ async def index():
     return HTMLResponse(index_html)
 
 
+@app.post('/')
+async def index(code: str, ip: str = Depends(error_ip_limit), s: AsyncSession = Depends(get_session)):
+    query = select(Codes).where(Codes.code == code)
+    info = (await s.execute(query)).scalars().first()
+    if not info:
+        error_count = settings.ERROR_COUNT - error_ip_limit.add_ip(ip)
+        raise HTTPException(status_code=404, detail=f"取件码错误，{error_count}次后将被禁止{settings.ERROR_MINUTE}分钟")
+    if info.exp_time < datetime.datetime.now() or info.count == 0:
+        raise HTTPException(status_code=404, detail="取件码已失效，请联系寄件人")
+    await s.execute(update(Codes).where(Codes.id == info.id).values(count=info.count - 1))
+    await s.commit()
+    if info.type != 'text':
+        info.text = f'/select?code={code}'
+    return {
+        'detail': f'取件成功，文件将在{settings.DELETE_EXPIRE_FILES_INTERVAL}分钟后删除',
+        'data': {'type': info.type, 'text': info.text, 'name': info.name, 'code': info.code}
+    }
+
+
 @app.get('/banner')
 async def banner(request: Request, s: AsyncSession = Depends(get_session)):
     # 数据库查询config
@@ -161,25 +181,6 @@ async def get_file(code: str, ip: str = Depends(error_ip_limit), s: AsyncSession
         return FileResponse(filepath, filename=info.name)
 
 
-@app.post('/')
-async def index(code: str, ip: str = Depends(error_ip_limit), s: AsyncSession = Depends(get_session)):
-    query = select(Codes).where(Codes.code == code)
-    info = (await s.execute(query)).scalars().first()
-    if not info:
-        error_count = settings.ERROR_COUNT - error_ip_limit.add_ip(ip)
-        raise HTTPException(status_code=404, detail=f"取件码错误，{error_count}次后将被禁止{settings.ERROR_MINUTE}分钟")
-    if info.exp_time < datetime.datetime.now() or info.count == 0:
-        raise HTTPException(status_code=404, detail="取件码已失效，请联系寄件人")
-    await s.execute(update(Codes).where(Codes.id == info.id).values(count=info.count - 1))
-    await s.commit()
-    if info.type != 'text':
-        info.text = f'/select?code={code}'
-    return {
-        'detail': f'取件成功，文件将在{settings.DELETE_EXPIRE_FILES_INTERVAL}分钟后删除',
-        'data': {'type': info.type, 'text': info.text, 'name': info.name, 'code': info.code}
-    }
-
-
 @app.post('/share', dependencies=[Depends(admin_required)], description='分享文件')
 async def share(background_tasks: BackgroundTasks, text: str = Form(default=None),
                 style: str = Form(default='2'), value: int = Form(default=1), file: UploadFile = File(default=None),

main.py

@@ -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")

readme.md

@@ -1,17 +1,17 @@
 from starlette.config import Config
 import os
 import shutil
-import encoding_convert
+# import encoding_convert
 
 # 配置文件.env
 # 请将.env移动至data目录，方便docker部署
 # 判断根目录下是否存在.env文件
 if os.path.exists('.env'):
     # 将文件复制到data目录
     shutil.copy('.env', 'data/.env')
-if os.path.exists('data/.env'):
-    # 获取data目录下的.env文件编码，如果为utf-8编码，就转换为gbk编码
-    encoding_convert.convert_encoding('./data/.env')
+# if os.path.exists('data/.env'):
+#     # 获取data目录下的.env文件编码，如果为utf-8编码，就转换为gbk编码
+#     encoding_convert.convert_encoding('./data/.env')
 
 config = Config("data/.env")
 # 是否开启DEBUG模式