swagger注解调整

src/main/java/com/yau/digitalrmb/platformintegration/interfaces/PlatformSsoController.java

@@ -5,6 +5,8 @@ import com.yau.digitalrmb.platformintegration.application.PlatformTokenVerifier;
 import com.yau.digitalrmb.platformintegration.application.VerifiedPlatformToken;
 import com.yau.digitalrmb.platformintegration.config.PlatformIntegrationProperties;
 import com.yau.digitalrmb.security.application.LoginExchangeCodeService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -32,6 +34,7 @@ public class PlatformSsoController {
     }
 
     @GetMapping("/sso")
+    @Operation(description = "单点登录鉴权")
     public ResponseEntity<Void> loginFromPlatform(@RequestParam("token") String token) {
         VerifiedPlatformToken verified = tokenVerifier.verify(token);
         projectionService.project(verified.actor());

src/main/java/com/yau/digitalrmb/security/interfaces/AuthController.java

@@ -10,7 +10,11 @@ import com.yau.digitalrmb.shared.api.ApiResponse;
 import com.yau.digitalrmb.shared.api.ErrorCode;
 import com.yau.digitalrmb.shared.exception.BusinessException;
 import com.yau.digitalrmb.shared.web.TraceIdFilter;
+
 import javax.validation.Valid;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.slf4j.MDC;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.security.oauth2.jwt.Jwt;
@@ -26,6 +30,7 @@ import java.util.Collections;
 
 @RestController
 @RequestMapping("/api/v1/auth")
+@Tag(name = "用户登录及权限认证")
 public class AuthController {
     private final JwtTokenService tokenService;
     private final LoginExchangeCodeService exchangeCodeService;
@@ -44,6 +49,7 @@ public class AuthController {
     }
 
     @PostMapping("/login")
+    @Operation(description = "用户登录")
     public ApiResponse<LoginResponse> login(@Valid @RequestBody LoginRequest request) {
         JwtTokenService.Token token = localAccountAuthenticationService.login(request.username(), request.password());
         return ApiResponse.success(new LoginResponse(token.accessToken(), "Bearer", token.expiresIn()),
@@ -65,7 +71,9 @@ public class AuthController {
     }
 
     @GetMapping("/me")
+    @Operation(description = "获取当前登录用户信息")
     public ApiResponse<CurrentUserResponse> currentUser(@AuthenticationPrincipal Jwt jwt) {
+        //todo 需要调整用户返回信息，具体返回数据参考旧系统
         long platformUserId = platformUserId(jwt);
         PlatformUserSnapshotEntity snapshot = snapshotMapper.selectById(platformUserId);
         if (snapshot == null) {
@@ -76,6 +84,7 @@ public class AuthController {
     }
 
     @PostMapping("/logout")
+    @Operation(description = "登出")
     public ApiResponse<Void> logout(@AuthenticationPrincipal Jwt jwt, @Valid @RequestBody LogoutRequest request) {
         refreshTokenService.revokeForUser(request.refreshToken(), platformUserId(jwt));
         return ApiResponse.success(null, MDC.get(TraceIdFilter.MDC_KEY));

src/main/java/com/yau/digitalrmb/security/interfaces/CurrentUserResponse.java

@@ -1,4 +1,15 @@
 package com.yau.digitalrmb.security.interfaces;
-import lombok.AllArgsConstructor; import lombok.Getter; import java.util.List;
+
-@Getter @AllArgsConstructor
+import lombok.AllArgsConstructor;
-public class CurrentUserResponse { private final long platformUserId; private final String account; private final String displayName; private final List<String> roles; }
+import lombok.Getter;
+
+import java.util.List;
+
+@Getter
+@AllArgsConstructor
+public class CurrentUserResponse {
+    private final long platformUserId;
+    private final String account;
+    private final String displayName;
+    private final List<String> roles;
+}