zyh/game_server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

添加Swagger/OpenAPI依赖并更新用户账户管理相关的API文档注释，优化用户和管理员账户控制器的接口描述，移除不必要的字段和参数，调整数据库映射以简化用户账户管理逻辑。

Browse Source
This commit is contained in:
zyh
2025-08-24 19:21:54 +08:00
parent 1b3ce1040a
commit 4664f1c487
64 changed files with 1688 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/main/java/com/gameplatform/server/controller/UserController.java
View File

@@ -5,6 +5,9 @@ import com.gameplatform.server.model.dto.account.AccountResponse;
import com.gameplatform.server.model.dto.account.AccountUpdateRequest;
import com.gameplatform.server.model.dto.common.PageResult;
import com.gameplatform.server.service.account.AccountService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;
@@ -16,6 +19,7 @@ import reactor.core.publisher.Mono;
*/
@RestController
@RequestMapping("/api/users")
@Tag(name = "用户账户管理", description = "用户账户的增删改查操作")
public class UserController {
private final AccountService accountService;
@@ -27,7 +31,8 @@ public class UserController {
* 根据ID获取用户账户信息
*/
@GetMapping("/{id}")
public Mono<AccountResponse> getById(@PathVariable Long id) {
@Operation(summary = "获取用户详情", description = "根据用户ID获取用户详细信息")
public Mono<AccountResponse> getById(@Parameter(description = "用户ID") @PathVariable Long id) {
return accountService.get(id);
}
@@ -35,15 +40,15 @@ public class UserController {
* 分页查询用户列表
*/
@GetMapping
@Operation(summary = "获取用户列表", description = "分页获取用户列表，支持按用户类型、状态、关键词筛选")
public Mono<PageResult<AccountResponse>> list(
@RequestParam(value = "userType", required = false) String userType,
@RequestParam(value = "status", required = false) String status,
@RequestParam(value = "role", required = false) String role,
@RequestParam(value = "keyword", required = false) String keyword,
@RequestParam(value = "page", defaultValue = "1") Integer page,
@RequestParam(value = "size", defaultValue = "20") Integer size
@Parameter(description = "用户类型：ADMIN 或 AGENT") @RequestParam(value = "userType", required = false) String userType,
@Parameter(description = "账户状态：ENABLED 或 DISABLED") @RequestParam(value = "status", required = false) String status,
@Parameter(description = "搜索关键词") @RequestParam(value = "keyword", required = false) String keyword,
@Parameter(description = "页码，默认1") @RequestParam(value = "page", defaultValue = "1") Integer page,
@Parameter(description = "每页大小，默认20") @RequestParam(value = "size", defaultValue = "20") Integer size
) {
return accountService.list(userType, status, role, keyword, page, size);
return accountService.list(userType, status, keyword, page, size);
}
/**
@@ -51,6 +56,7 @@ public class UserController {
*/
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
@Operation(summary = "创建用户", description = "创建新的代理用户账户")
public Mono<AccountResponse> create(@Valid @RequestBody AccountCreateRequest request) {
return accountService.create(request);
}
@@ -59,7 +65,8 @@ public class UserController {
* 更新用户账户信息
*/
@PutMapping("/{id}")
public Mono<AccountResponse> update(@PathVariable Long id, @Valid @RequestBody AccountUpdateRequest request) {
@Operation(summary = "更新用户", description = "更新用户账户信息")
public Mono<AccountResponse> update(@Parameter(description = "用户ID") @PathVariable Long id, @Valid @RequestBody AccountUpdateRequest request) {
return accountService.update(id, request);
}
@@ -68,7 +75,8 @@ public class UserController {
*/
@PostMapping("/{id}/enable")
@ResponseStatus(HttpStatus.NO_CONTENT)
public Mono<Void> enable(@PathVariable Long id) {
@Operation(summary = "启用用户", description = "启用指定用户账户")
public Mono<Void> enable(@Parameter(description = "用户ID") @PathVariable Long id) {
return accountService.setStatus(id, "ENABLED").then();
}
@@ -77,7 +85,8 @@ public class UserController {
*/
@PostMapping("/{id}/disable")
@ResponseStatus(HttpStatus.NO_CONTENT)
public Mono<Void> disable(@PathVariable Long id) {
@Operation(summary = "禁用用户", description = "禁用指定用户账户")
public Mono<Void> disable(@Parameter(description = "用户ID") @PathVariable Long id) {
return accountService.setStatus(id, "DISABLED").then();
}
}

34
src/main/java/com/gameplatform/server/controller/admin/AccountController.java
View File

@@ -3,6 +3,9 @@ package com.gameplatform.server.controller.admin;
import com.gameplatform.server.model.dto.account.*;
import com.gameplatform.server.model.dto.common.PageResult;
import com.gameplatform.server.service.account.AccountService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;
@@ -10,6 +13,7 @@ import reactor.core.publisher.Mono;
@RestController
@RequestMapping("/api/admin/accounts")
@Tag(name = "管理员账户管理", description = "管理员账户的增删改查操作")
public class AccountController {
private final AccountService accountService;
@@ -18,48 +22,54 @@ public class AccountController {
}
@GetMapping
@Operation(summary = "获取账户列表", description = "分页获取账户列表，支持按用户类型、状态、关键词筛选")
public Mono<PageResult<AccountResponse>> list(
@RequestParam(value = "userType", required = false) String userType,
@RequestParam(value = "status", required = false) String status,
@RequestParam(value = "role", required = false) String role,
@RequestParam(value = "keyword", required = false) String keyword,
@RequestParam(value = "page", required = false) Integer page,
@RequestParam(value = "size", required = false) Integer size
@Parameter(description = "用户类型：ADMIN 或 AGENT") @RequestParam(value = "userType", required = false) String userType,
@Parameter(description = "账户状态：ENABLED 或 DISABLED") @RequestParam(value = "status", required = false) String status,
@Parameter(description = "搜索关键词") @RequestParam(value = "keyword", required = false) String keyword,
@Parameter(description = "页码，默认1") @RequestParam(value = "page", required = false) Integer page,
@Parameter(description = "每页大小，默认20，最大200") @RequestParam(value = "size", required = false) Integer size
) {
return accountService.list(userType, status, role, keyword, page, size);
return accountService.list(userType, status, keyword, page, size);
}
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
@Operation(summary = "创建账户", description = "创建新的管理员或代理账户")
public Mono<AccountResponse> create(@Valid @RequestBody AccountCreateRequest req) {
return accountService.create(req);
}
@GetMapping("/{id}")
public Mono<AccountResponse> detail(@PathVariable Long id) {
@Operation(summary = "获取账户详情", description = "根据账户ID获取账户详细信息")
public Mono<AccountResponse> detail(@Parameter(description = "账户ID") @PathVariable Long id) {
return accountService.get(id);
}
@PatchMapping("/{id}")
public Mono<AccountResponse> update(@PathVariable Long id, @Valid @RequestBody AccountUpdateRequest req) {
@Operation(summary = "更新账户", description = "更新账户信息")
public Mono<AccountResponse> update(@Parameter(description = "账户ID") @PathVariable Long id, @Valid @RequestBody AccountUpdateRequest req) {
return accountService.update(id, req);
}
@PostMapping("/{id}/enable")
@ResponseStatus(HttpStatus.NO_CONTENT)
public Mono<Void> enable(@PathVariable Long id) {
@Operation(summary = "启用账户", description = "启用指定账户")
public Mono<Void> enable(@Parameter(description = "账户ID") @PathVariable Long id) {
return accountService.setStatus(id, "ENABLED").then();
}
@PostMapping("/{id}/disable")
@ResponseStatus(HttpStatus.NO_CONTENT)
public Mono<Void> disable(@PathVariable Long id) {
@Operation(summary = "禁用账户", description = "禁用指定账户")
public Mono<Void> disable(@Parameter(description = "账户ID") @PathVariable Long id) {
return accountService.setStatus(id, "DISABLED").then();
}
@PostMapping("/{id}/reset-password")
@ResponseStatus(HttpStatus.NO_CONTENT)
public Mono<Void> resetPassword(@PathVariable Long id, @Valid @RequestBody ResetPasswordRequest req) {
@Operation(summary = "重置密码", description = "重置指定账户的密码")
public Mono<Void> resetPassword(@Parameter(description = "账户ID") @PathVariable Long id, @Valid @RequestBody ResetPasswordRequest req) {
return accountService.resetPassword(id, req.getNewPassword(), Boolean.TRUE.equals(req.getForceLogout()));
}
}