From d1be97a36645d43c892162432f76aaa1b392841c Mon Sep 17 00:00:00 2001 From: set Date: Fri, 13 Feb 2026 20:56:11 +0800 Subject: [PATCH] feat: doc change --- .../sunway/ai_spring_example/Docs/api-dev-standard.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/src/main/java/icu/sunway/ai_spring_example/Docs/api-dev-standard.md b/src/main/java/icu/sunway/ai_spring_example/Docs/api-dev-standard.md index 3549bd3..5a3b296 100644 --- a/src/main/java/icu/sunway/ai_spring_example/Docs/api-dev-standard.md +++ b/src/main/java/icu/sunway/ai_spring_example/Docs/api-dev-standard.md @@ -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. 整体架构规范