docs(swagger): personalize Swagger UI for user registration

Author: andrefelipebarros

securetimenotes/src/main/java/securetimenotes/andrefelipebarros/securetimenotes/controllers/AuthenticationController.java

@@ -2,7 +2,7 @@
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
-
+import io.swagger.v3.oas.annotations.tags.Tag;
 
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -30,6 +30,7 @@
 
 @RestController
 @RequestMapping("auth")
+@Tag(name = "Authentificação do Usuário", description = "Endpoints para criar autentificação do usuário.")
 @CrossOrigin(origins = "*")
 public class AuthenticationController {
     @Autowired

securetimenotes/src/main/java/securetimenotes/andrefelipebarros/securetimenotes/controllers/NotesController.java

@@ -1,5 +1,9 @@
 package securetimenotes.andrefelipebarros.securetimenotes.controllers;
 
+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.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -17,10 +21,12 @@
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
-
 @RestController
 @RequestMapping("user")
+@Tag(name = "Notas do Usuário", description = "Endpoints para criar e visualizar notas do usuário autenticado.")
+@SecurityRequirement(name = "bearerAuth")
 public class NotesController {
+
     @Autowired
     NotesRespository noteRepository;
 
@@ -29,12 +35,16 @@ public class NotesController {
 
     @GetMapping("/notes")
     @PreAuthorize("hasRole('USER')")
+    @Operation(summary = "Listar notas do usuário", 
+                description = "Retorna todas as notas do usuário autenticado. É necessário fornecer um token de autenticação.")
     public List<Note> getNotes(@AuthenticationPrincipal User user) {
         return noteRepository.findByUser(user);
     }
 
     @PostMapping("/notes")
     @PreAuthorize("hasRole('USER')")
+    @Operation(summary = "Criar nova nota", 
+                description = "Cria uma nova nota associada ao usuário autenticado. Requer autenticação.")
     public void postNotes(@AuthenticationPrincipal User user, @RequestBody Note note) {
         note.setUser(user);
         noteRepository.save(note);

securetimenotes/src/main/java/securetimenotes/andrefelipebarros/securetimenotes/infra/security/SecurityConfiguration.java

@@ -36,7 +36,7 @@ public SecurityFilterChain securityFilterChain(HttpSecurity httpSecurity) throws
             .requestMatchers(HttpMethod.POST, "/auth/login").permitAll()
             .requestMatchers(HttpMethod.POST, "/auth/register").permitAll()
             .requestMatchers("/h2-console/**").permitAll()
-            // .requestMatchers("/swagger").permitAll()
+            .requestMatchers("/swagger**", "/v3/api-docs/**", "/swagger-ui/**", "/swagger-ui.html").permitAll()
             .anyRequest().authenticated()
         )
         .addFilterBefore(securityFilter, UsernamePasswordAuthenticationFilter.class)

securetimenotes/src/main/java/securetimenotes/andrefelipebarros/securetimenotes/model/user/body/RegisterDTO.java

@@ -1,6 +1,16 @@
 package securetimenotes.andrefelipebarros.securetimenotes.model.user.body;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import securetimenotes.andrefelipebarros.securetimenotes.model.user.UserRole;
 
 //Register Body:
-public record RegisterDTO(String username, String password, UserRole role) {}
+public record RegisterDTO(
+    @Schema(description = "Email válido do usuário")
+    String username, 
+
+    @Schema(description = "Senha com no mínimo 8 caracteres, 1 letra maiúscula, 1 número e 1 caractere especial")
+    String password,
+
+    @Schema(hidden = true)
+    UserRole role
+) {}