Update swagger

Author: Throyer

src/main/java/com/github/throyer/common/springboot/controllers/api/ApiController.java

@@ -2,6 +2,7 @@
 
 import com.github.throyer.common.springboot.utils.Hello;
 
+import io.swagger.v3.oas.annotations.Operation;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -11,6 +12,7 @@
 public class ApiController {
 
     @GetMapping
+    @Operation(hidden = true)
     public Hello index() {
         return () -> "Is a live!";
     }

src/main/java/com/github/throyer/common/springboot/controllers/api/RecoveriesController.java

@@ -9,6 +9,8 @@
 import com.github.throyer.common.springboot.domain.recovery.model.RecoveryRequest;
 import com.github.throyer.common.springboot.domain.recovery.model.RecoveryUpdate;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -17,31 +19,45 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
+@Tag(name = "Password recovery")
 @RequestMapping("/api/recoveries")
 public class RecoveriesController {
 
+    private final RecoveryService recoveryService;
+    private final RecoveryConfirmService confirmService;
+    private final RecoveryUpdateService updateService;
+
     @Autowired
-    private RecoveryService recoveryService;
-    
-    @Autowired
-    private RecoveryConfirmService confirmService;
-    
-    @Autowired
-    private RecoveryUpdateService updateService;
+    public RecoveriesController(
+        RecoveryService recoveryService,
+        RecoveryConfirmService confirmService,
+        RecoveryUpdateService updateService
+    ) {
+        this.recoveryService = recoveryService;
+        this.confirmService = confirmService;
+        this.updateService = updateService;
+    }
 
     @PostMapping
     @ResponseStatus(NO_CONTENT)
-    public void index(@RequestBody RecoveryRequest request) {        
+    @Operation(
+        summary = "Starts recovery password process",
+        description = "Sends a email to user with recovery code"
+    )
+    public void recovery(@RequestBody RecoveryRequest request) {
         recoveryService.recovery(request.getEmail());
     }
 
     @PostMapping("/confirm")
-    public void confirm(@RequestBody RecoveryConfirm confirm) {        
+    @ResponseStatus(NO_CONTENT)
+    @Operation(summary = "Confirm recovery code")
+    public void confirm(@RequestBody RecoveryConfirm confirm) {
         confirmService.confirm(confirm.getEmail(), confirm.getCode());
     }
 
     @PostMapping("/update")
     @ResponseStatus(NO_CONTENT)
+    @Operation(summary = "Update user password")
     public void update(@RequestBody RecoveryUpdate update) {        
         updateService.update(update.getEmail(), update.getCode(), update.getPassword());
     }

src/main/java/com/github/throyer/common/springboot/controllers/api/RolesController.java

@@ -6,8 +6,10 @@
 
 import com.github.throyer.common.springboot.domain.role.entity.Role;
 import com.github.throyer.common.springboot.domain.role.repository.RoleRepository;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -16,6 +18,7 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
+@Tag(name = "Roles")
 @RequestMapping("/api/roles")
 @SecurityRequirement(name = "token")
 @PreAuthorize("hasAnyAuthority('ADM')")
@@ -25,6 +28,7 @@ public class RolesController {
     private RoleRepository repository;
 
     @GetMapping
+    @Operation(summary = "Returns a list of roles")
     public ResponseEntity<List<Role>> index() {
         return ok(repository.findAll());
     }

src/main/java/com/github/throyer/common/springboot/controllers/api/SessionsController.java

@@ -10,6 +10,8 @@
 import com.github.throyer.common.springboot.domain.session.service.RefreshTokenService;
 import static com.github.throyer.common.springboot.utils.Responses.ok;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -18,22 +20,31 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
+@Tag(name = "Authentication")
 @RequestMapping("/api/sessions")
 public class SessionsController {
 
+    private final CreateTokenService createService;
+    private final RefreshTokenService refreshService;
+
     @Autowired
-    private CreateTokenService createService;
-    
-    @Autowired
-    private RefreshTokenService refreshService;
+    public SessionsController(
+        CreateTokenService createService,
+        RefreshTokenService refreshService
+    ) {
+        this.createService = createService;
+        this.refreshService = refreshService;
+    }
 
     @PostMapping
+    @Operation(summary = "Create a jwt token")
     public ResponseEntity<TokenResponse> create(@RequestBody @Valid TokenRequest request) {
         var token = createService.create(request);
         return ok(token);
     }
 
     @PostMapping("/refresh")
+    @Operation(summary = "Create a new jwt token from refresh code")
     public ResponseEntity<RefreshTokenResponse> refresh(@RequestBody @Valid RefreshTokenRequest request) {
         var token = refreshService.refresh(request);
         return ok(token);

src/main/java/com/github/throyer/common/springboot/controllers/api/UsersController.java

@@ -16,10 +16,12 @@
 import com.github.throyer.common.springboot.domain.user.service.UpdateUserService;
 import com.github.throyer.common.springboot.domain.user.model.UserDetails;
 
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 
 import java.util.Optional;
 
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -35,6 +37,7 @@
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
+@Tag(name = "Users")
 @RequestMapping("/api/users")
 public class UsersController {
 
@@ -58,10 +61,11 @@ public UsersController(
         this.findService = findService;
         this.findByIdService = findByIdService;
     }
-    
+
     @GetMapping
     @SecurityRequirement(name = "token")
     @PreAuthorize("hasAnyAuthority('ADM')")
+    @Operation(summary = "Returns a list of users")
     public ResponseEntity<Page<UserDetails>> index(
         Optional<Integer> page,
         Optional<Integer> size
@@ -73,13 +77,15 @@ public ResponseEntity<Page<UserDetails>> index(
     @GetMapping("/{id}")
     @SecurityRequirement(name = "token")
     @PreAuthorize("hasAnyAuthority('ADM', 'USER')")
+    @Operation(summary = "Show user info")
     public ResponseEntity<UserDetails> show(@PathVariable Long id) {
         var user = findByIdService.find(id);
         return ok(user);
     }
 
     @PostMapping
     @ResponseStatus(CREATED)
+    @Operation(summary = "Register a new user", description = "Returns the new user")
     public ResponseEntity<UserDetails> save(
         @Validated @RequestBody CreateUserProps props
     ) {
@@ -91,6 +97,7 @@ public ResponseEntity<UserDetails> save(
     @PutMapping("/{id}")
     @SecurityRequirement(name = "token")
     @PreAuthorize("hasAnyAuthority('ADM', 'USER')")
+    @Operation(summary = "Update user data")
     public ResponseEntity<UserDetails> update(
         @PathVariable Long id,
         @RequestBody @Validated UpdateUserProps body
@@ -102,6 +109,7 @@ public ResponseEntity<UserDetails> update(
     @DeleteMapping("/{id}")
     @ResponseStatus(NO_CONTENT)
     @SecurityRequirement(name = "token")
+    @Operation(summary = "Delete user")
     public void destroy(@PathVariable Long id) {
         removeService.remove(id);
     }