docs: 批量更新历史文档中的 backend-single 引用为 server
This commit is contained in:
@@ -15,28 +15,28 @@
|
||||
### 后端改动文件（按批次）
|
||||
|
||||
**Batch 1 (P0):**
|
||||
- `backend-single/src/main/java/com/emotion/controller/AdminAuthController.java` — 已有 @Operation，补全 @Parameter
|
||||
- `backend-single/src/main/java/com/emotion/controller/AuthController.java` — 补全缺少的 @Operation，补全 @Parameter
|
||||
- `backend-single/src/main/java/com/emotion/controller/AdminController.java` — 已有 @Tag/@Operation，补全 @Parameter
|
||||
- `backend-single/src/main/java/com/emotion/controller/TokenController.java` — 已有 @Operation，检查完整度
|
||||
- `backend-single/src/main/java/com/emotion/controller/AdminAnalyticsController.java` — 新增 @Tag/@Operation
|
||||
- `backend-single/src/main/java/com/emotion/controller/UserController.java` — 新增 @Tag/@Operation
|
||||
- `backend-single/src/main/java/com/emotion/controller/UserProfileController.java` — 新增 @Tag/@Operation
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminLoginRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminCreateRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminUpdateRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminPageRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminChangePasswordRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/AdminResetPasswordRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/RefreshTokenRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/ResetPasswordRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/RegisterRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/LoginRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/UserCreateRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/UserUpdateRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/UserPageRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/UserProfileUpdateRequest.java` — 补全 @Schema
|
||||
- `backend-single/src/main/java/com/emotion/dto/request/analytics/AnalyticsQueryRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/controller/AdminAuthController.java` — 已有 @Operation，补全 @Parameter
|
||||
- `server/src/main/java/com/emotion/controller/AuthController.java` — 补全缺少的 @Operation，补全 @Parameter
|
||||
- `server/src/main/java/com/emotion/controller/AdminController.java` — 已有 @Tag/@Operation，补全 @Parameter
|
||||
- `server/src/main/java/com/emotion/controller/TokenController.java` — 已有 @Operation，检查完整度
|
||||
- `server/src/main/java/com/emotion/controller/AdminAnalyticsController.java` — 新增 @Tag/@Operation
|
||||
- `server/src/main/java/com/emotion/controller/UserController.java` — 新增 @Tag/@Operation
|
||||
- `server/src/main/java/com/emotion/controller/UserProfileController.java` — 新增 @Tag/@Operation
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminLoginRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminCreateRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminUpdateRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminPageRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminChangePasswordRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/AdminResetPasswordRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/RefreshTokenRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/ResetPasswordRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/RegisterRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/LoginRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/UserCreateRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/UserUpdateRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/UserPageRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/UserProfileUpdateRequest.java` — 补全 @Schema
|
||||
- `server/src/main/java/com/emotion/dto/request/analytics/AnalyticsQueryRequest.java` — 补全 @Schema
|
||||
|
||||
### 前端改动文件
|
||||
|
||||
@@ -48,8 +48,8 @@
|
||||
## Task 1: 后端 Batch 1 - AdminAuth + Auth Controller 注解补全
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/AdminAuthController.java`
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/AuthController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/AdminAuthController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/AuthController.java`
|
||||
|
||||
- [ ] **Step 1: 查看 AdminAuthController 已有注解**
|
||||
|
||||
@@ -85,7 +85,7 @@ AuthController 已有 @Tag。需要补全以下方法的 @Operation：
|
||||
|
||||
- [ ] **Step 3: 为 AuthController 缺少的方法补全注解**
|
||||
|
||||
修改 `backend-single/src/main/java/com/emotion/controller/AuthController.java`：
|
||||
修改 `server/src/main/java/com/emotion/controller/AuthController.java`：
|
||||
|
||||
为以下方法添加 @Operation（在方法上方的空白行插入）：
|
||||
|
||||
@@ -133,7 +133,7 @@ AdminAuthController 的 6 个方法全部有 @Operation，无需修改。
|
||||
- [ ] **Step 5: 提交**
|
||||
|
||||
```bash
|
||||
git add backend-single/src/main/java/com/emotion/controller/AuthController.java
|
||||
git add server/src/main/java/com/emotion/controller/AuthController.java
|
||||
git commit -m "feat: 补全 AuthController 缺失的 @Operation 和 @Parameter 注解"
|
||||
```
|
||||
|
||||
@@ -142,16 +142,16 @@ git commit -m "feat: 补全 AuthController 缺失的 @Operation 和 @Parameter
|
||||
## Task 2: 后端 Batch 1 - Admin + Token Controller 注解补全
|
||||
|
||||
**Files:**
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/AdminController.java`
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/TokenController.java`
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/AdminAnalyticsController.java`
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/UserController.java`
|
||||
- Modify: `backend-single/src/main/java/com/emotion/controller/UserProfileController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/AdminController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/TokenController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/AdminAnalyticsController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/UserController.java`
|
||||
- Modify: `server/src/main/java/com/emotion/controller/UserProfileController.java`
|
||||
|
||||
- [ ] **Step 1: 读取 AdminController**
|
||||
|
||||
```bash
|
||||
cat backend-single/src/main/java/com/emotion/controller/AdminController.java
|
||||
cat server/src/main/java/com/emotion/controller/AdminController.java
|
||||
```
|
||||
|
||||
检查每个方法的 @Operation 是否有 @Parameter，为路径参数和查询参数补全 @Parameter 注解。
|
||||
@@ -159,7 +159,7 @@ cat backend-single/src/main/java/com/emotion/controller/AdminController.java
|
||||
- [ ] **Step 2: 读取 TokenController**
|
||||
|
||||
```bash
|
||||
cat backend-single/src/main/java/com/emotion/controller/TokenController.java
|
||||
cat server/src/main/java/com/emotion/controller/TokenController.java
|
||||
```
|
||||
|
||||
已有 3 个 @Operation，检查是否缺少 @Parameter，补全。
|
||||
@@ -194,11 +194,11 @@ public Result<AnalyticsOverviewResponse> overview(@Validated AnalyticsQueryReque
|
||||
- [ ] **Step 6: 提交**
|
||||
|
||||
```bash
|
||||
git add backend-single/src/main/java/com/emotion/controller/AdminController.java
|
||||
git add backend-single/src/main/java/com/emotion/controller/TokenController.java
|
||||
git add backend-single/src/main/java/com/emotion/controller/AdminAnalyticsController.java
|
||||
git add backend-single/src/main/java/com/emotion/controller/UserController.java
|
||||
git add backend-single/src/main/java/com/emotion/controller/UserProfileController.java
|
||||
git add server/src/main/java/com/emotion/controller/AdminController.java
|
||||
git add server/src/main/java/com/emotion/controller/TokenController.java
|
||||
git add server/src/main/java/com/emotion/controller/AdminAnalyticsController.java
|
||||
git add server/src/main/java/com/emotion/controller/UserController.java
|
||||
git add server/src/main/java/com/emotion/controller/UserProfileController.java
|
||||
git commit -m "feat: 为 Admin/Token/AdminAnalytics/User/UserProfile Controller 补全 OpenAPI 注解"
|
||||
```
|
||||
|
||||
@@ -257,21 +257,21 @@ import io.swagger.v3.oas.annotations.media.Schema;
|
||||
- [ ] **Step 3: 提交**
|
||||
|
||||
```bash
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/LoginRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/RegisterRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/ResetPasswordRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/RefreshTokenRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminLoginRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminCreateRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminUpdateRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminPageRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminChangePasswordRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/AdminResetPasswordRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/UserCreateRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/UserUpdateRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/UserPageRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/UserProfileUpdateRequest.java
|
||||
git add backend-single/src/main/java/com/emotion/dto/request/analytics/AnalyticsQueryRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/LoginRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/RegisterRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/ResetPasswordRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/RefreshTokenRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminLoginRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminCreateRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminUpdateRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminPageRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminChangePasswordRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/AdminResetPasswordRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/UserCreateRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/UserUpdateRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/UserPageRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/UserProfileUpdateRequest.java
|
||||
git add server/src/main/java/com/emotion/dto/request/analytics/AnalyticsQueryRequest.java
|
||||
git commit -m "feat: 为 Batch 1 请求 DTO 补全 @Schema 中文描述注解"
|
||||
```
|
||||
|
||||
@@ -665,7 +665,7 @@ git commit -m "feat: 测试面板增加请求头展示区域"
|
||||
- [ ] **Step 1: 本地构建后端**
|
||||
|
||||
```bash
|
||||
cd backend-single
|
||||
cd server
|
||||
mvn clean install -DskipTests
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user