gushen/template-springboot-hucky
1
0
Fork 4
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: doc change

Browse Source
This commit is contained in:
set
2026-02-13 20:56:11 +08:00
parent 1eafeacf36
commit d1be97a366
1 changed files with 0 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/java/icu/sunway/ai_spring_example/Docs/api-dev-standard.md
View File

@@ -7,17 +7,6 @@
- **api-dev-standard.md**：指导**代码实现**（如何编写符合规范的代码）
- **api-doc-standard.md**：定义**接口契约**（请求/响应格式标准）
### 关键一致性说明
| 规范维度 | 代码实现规范 (本文件) | 接口文档规范 (api-doc-standard) | 对齐状态 |
| ------------ | -------------------------------- | ----------------------------------- | -------------------------------------- |
| **响应格式** | 必须使用ResponseUtils生成响应 | 强制要求code/message/timestamp/data | ✅ 对齐 |
| **分页参数** | 代码中参数名: `page`/`limit` | 文档中参数名: `page`/`limit` | ✅ 语义对齐（page=current, limit=size） |
| **状态码** | ResponseUtils需支持400/401等状态 | 明确200/400/401等状态码语义 | ⚠️ 需增强 |
| **时间字段** | Entity用LocalDateTime | 响应用时间戳(Integer) | ⚠️ 需转换 |
> **特别说明**：当前代码中`ResponseUtils`实现需扩展以完全符合api-doc-standard，但开发规范以**实际代码结构**为准。
---
## 1. 整体架构规范