[refractor]swagger

Author: Snailclimb

src/main/java/github/javaguide/springsecurityjwtguide/security/controller/AuthController.java

@@ -3,6 +3,8 @@
 import github.javaguide.springsecurityjwtguide.security.common.constants.SecurityConstants;
 import github.javaguide.springsecurityjwtguide.security.dto.LoginRequest;
 import github.javaguide.springsecurityjwtguide.security.service.AuthService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpHeaders;
@@ -20,11 +22,13 @@
 @RestController
 @RequestMapping("/auth")
 @RequiredArgsConstructor(onConstructor = @__(@Autowired))
+@Api(tags = "认证")
 public class AuthController {
 
     private final AuthService authService;
 
     @PostMapping("/login")
+    @ApiOperation("登录")
     public ResponseEntity<Void> login(@RequestBody LoginRequest loginRequest) {
         String token = authService.getToken(loginRequest);
         HttpHeaders httpHeaders = new HttpHeaders();
@@ -33,6 +37,7 @@ public ResponseEntity<Void> login(@RequestBody LoginRequest loginRequest) {
     }
 
     @PostMapping("/logout")
+    @ApiOperation("退出")
     public ResponseEntity<Void> logout() {
         authService.deleteTokenFromRedis();
         return new ResponseEntity<>(HttpStatus.OK);

src/main/java/github/javaguide/springsecurityjwtguide/system/web/controller/UserController.java

@@ -4,6 +4,8 @@
 import github.javaguide.springsecurityjwtguide.system.web.representation.UserRepresentation;
 import github.javaguide.springsecurityjwtguide.system.web.request.UserRegisterRequest;
 import github.javaguide.springsecurityjwtguide.system.web.request.UserUpdateRequest;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.domain.Page;
@@ -26,32 +28,37 @@
 @RestController
 @RequiredArgsConstructor(onConstructor = @__(@Autowired))
 @RequestMapping("/users")
+@Api(tags = "用户")
 public class UserController {
 
     private final UserService userService;
 
     @PostMapping("/sign-up")
+    @ApiOperation("用户注册")
     public ResponseEntity<Void> signUp(@RequestBody @Valid UserRegisterRequest userRegisterRequest) {
         userService.save(userRegisterRequest);
         return ResponseEntity.ok().build();
     }
 
     @GetMapping
     @PreAuthorize("hasAnyRole('ROLE_USER','ROLE_MANAGER','ROLE_ADMIN')")
+    @ApiOperation("获取所有用户的信息（分页）")
     public ResponseEntity<Page<UserRepresentation>> getAllUser(@RequestParam(value = "pageNum", defaultValue = "0") int pageNum, @RequestParam(value = "pageSize", defaultValue = "10") int pageSize) {
         Page<UserRepresentation> allUser = userService.getAll(pageNum, pageSize);
         return ResponseEntity.ok().body(allUser);
     }
 
     @PutMapping
     @PreAuthorize("hasAnyRole('ROLE_ADMIN')")
+    @ApiOperation("更新用户")
     public ResponseEntity<Void> update(@RequestBody @Valid UserUpdateRequest userUpdateRequest) {
         userService.update(userUpdateRequest);
         return ResponseEntity.ok().build();
     }
 
     @DeleteMapping
     @PreAuthorize("hasAnyRole('ROLE_ADMIN')")
+    @ApiOperation("根据用户名删除用户")
     public ResponseEntity<Void> deleteUserByUserName(@RequestParam("username") String username) {
         userService.delete(username);
         return ResponseEntity.ok().build();