feat: Add Swagger integration for endpoint API documentation

Author: felipemelozx

pom.xml

@@ -80,6 +80,11 @@
 			<artifactId>java-jwt</artifactId>
 			<version>4.4.0</version>
 		</dependency>
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>2.8.6</version>
+		</dependency>
 	</dependencies>
 
 	<build>

src/main/java/fun/trackmoney/auth/infra/config/SecurityConfig.java

@@ -38,6 +38,7 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
             .requestMatchers(HttpMethod.POST, "/auth/register").permitAll()
             .requestMatchers(HttpMethod.GET, "/health/**").permitAll()
             .requestMatchers(HttpMethod.GET, "/actuator/**").permitAll()
+            .requestMatchers("/swagger-ui/**", "/v3/api-docs/**").permitAll()
             .anyRequest().authenticated()
         )
         .addFilterBefore(securityFilter, UsernamePasswordAuthenticationFilter.class);

…ception/config/RestExceptionHandler.java …nfig/exception/RestExceptionHandler.javasrc/main/java/fun/trackmoney/exception/config/RestExceptionHandler.java renamed to src/main/java/fun/trackmoney/config/exception/RestExceptionHandler.java src/main/java/fun/trackmoney/exception/config/RestExceptionHandler.java renamed to src/main/java/fun/trackmoney/config/exception/RestExceptionHandler.java

@@ -1,4 +1,4 @@
-package fun.trackmoney.exception.config;
+package fun.trackmoney.config.exception;
 
 import fun.trackmoney.user.exception.EmailAlreadyExistsException;
 import fun.trackmoney.user.exception.PasswordNotValid;

src/main/java/fun/trackmoney/config/swagger/SwaggerConfig.java

@@ -0,0 +1,24 @@
+package fun.trackmoney.config.swagger;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfig {
+
+  @Bean
+  public OpenAPI customOpenAPI() {
+    return new OpenAPI()
+        .info(new Info()
+            .title("TrackMoney API Manager Finance")
+            .version("v1")
+            .description("This is the backend part of a full-stack financial management application, " +
+                "designed to handle essential features like user authentication, CRUD operations " +
+                "for financial resources (transactions, budgets, recurring accounts), and more. " +
+                "The backend is built using Java 17, Spring Boot, Spring Security, and follows " +
+                "the Clean Architecture principles. It is integrated with a PostgreSQL database " +
+                "and includes a CI/CD pipeline for continuous integration and deployment."));
+  }
+}

src/main/java/fun/trackmoney/user/dtos/UserRequestDTO.java

@@ -6,7 +6,7 @@
 public record UserRequestDTO(
     @NotBlank(message = "Name is required")
     String name,
-    @Email(message = "Email inlaid")
+    @Email(message = "Email is invalid")
     @NotBlank
     String email,
     @NotBlank(message = "Password is required")

…ion/config/RestExceptionHandlerTest.java …/exception/RestExceptionHandlerTest.javasrc/test/java/fun/trackmoney/exception/config/RestExceptionHandlerTest.java renamed to src/test/java/fun/trackmoney/config/exception/RestExceptionHandlerTest.java src/test/java/fun/trackmoney/exception/config/RestExceptionHandlerTest.java renamed to src/test/java/fun/trackmoney/config/exception/RestExceptionHandlerTest.java

@@ -1,4 +1,4 @@
-package fun.trackmoney.exception.config;
+package fun.trackmoney.config.exception;
 
 import fun.trackmoney.user.exception.EmailAlreadyExistsException;
 import fun.trackmoney.user.exception.PasswordNotValid;