tcjlj/OpenFlare
1
0
Fork 0
mirror of https://github.com/Rain-kl/OpenFlare.git synced 2026-09-30 06:16:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: 添加Swagger文档使用说明，更新开发规范中的Swagger约束

Browse Source
This commit is contained in:
ryan
2026-03-11 14:35:39 +08:00
parent 6166192667
commit 5e963dc472
2 changed files with 38 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development-guidelines.md
+10 -10
View File
@@ -296,13 +296,13 @@ V3 新增行为：
更新顺序：
1. `docs/design.md`
2. `docs/development-guidelines.md`
3. `docs/development-plan.md`
4. `docs/deployment.md`
## 12. Swagger 鏂囨。绾︽潫
* Server 鎻愪緵 Swagger UI 鍏ュ彛锛?`/swagger/index.html`
* Swagger UI 浠呭宸茬櫥褰曠殑绠＄悊绔敤鎴峰紑鏀撅紝涓嶅悜鍖垮悕鐢ㄦ埛鍏紑
* 鏂板鎴栦慨鏀?API 鏃讹紝闇€鍚屾鏇存柊 Swag 娉ㄨВ骞堕噸鏂扮敓鎴?`atsf_server/docs`
1. `docs/design.md`
2. `docs/development-guidelines.md`
3. `docs/development-plan.md`
4. `docs/deployment.md`
## 12. Swagger 文档约束
* Server 提供 Swagger UI 入口：`/swagger/index.html`
* Swagger UI 仅对已登录的管理端用户开放，不向匿名用户公开
* 新增或修改 API 时，必须同步更新 Swag 注解并重新生成 `atsf_server/docs`