commit 58245ed3d7a85c5b3fa8da386cf8426ea5ad1033 Author: bid-docs <bid-docs@localhost> Date: 2026-01-21T11:48:22+08:00 Add admin login and docs CRUD API diff --git a/docs/18-docs-rest-api.md b/docs/18-docs-rest-api.md index cf4b585..8bb80b7 100644 --- a/docs/18-docs-rest-api.md +++ b/docs/18-docs-rest-api.md @@ -7,6 +7,20 @@ - 备用 Header：`X-API-Key: <BID_API_TOKEN>` ## 1.1 Token 来源 - `.env` 文件中的 `BID_API_TOKEN` +## 1.2 登录获取 Token +`POST /api/auth/login` + +Body: +```json +{ "username": "admin", "password": "whoami139" } +``` + +Response: +```json +{ "code": 0, "message": "ok", "data": { "username": "admin", "token": "<BID_API_TOKEN>" } } +``` + +`GET /api/auth/me`（需要 Token） ## 2. 基础路径 - 线上：`https://bid.hao.work/docs/api/` @@ -14,7 +28,7 @@ ## 3. 接口清单 ### 3.1 获取文档列表 -`GET /api/docs` +`GET /api/docs`（需要 Token） Response: ```json @@ -32,6 +46,16 @@ Response: ### 3.4 获取文档差异 `GET /api/docs/diff?path=01-product-requirements.md&hash=<commit>` +### 3.4.1 文档增删改（需要 Token） +- `POST /api/docs` +- `PUT /api/docs` +- `DELETE /api/docs?path=<file>` + +POST/PUT Body 示例： +```json +{ "path": "99-new-doc.md", "content": "# New Doc\n\n内容..." } +``` + ### 3.5 迭代信息 - `GET /api/iterations` - `POST /api/iterations` @@ -65,5 +89,6 @@ POST Body 示例： ## 4. 错误码 - `40101` 未认证或 Token 错误 - `40001` 参数错误 +- `40901` 资源冲突（已存在） - `40401` 资源不存在 - `50001` 服务错误