Documenta endpoints da API com OpenAPI/Swagger

.gitignore

@@ -38,4 +38,8 @@ src/main/resources/http
 desktop.ini
 Desktop.ini
 
-src/main/resources/firebase/
+src/main/resources/firebase/
+skills/
+
+*.env
+*.json

src/main/java/br/com/acta/common/config/firebase/FirebaseAuthFilter.java

@@ -25,7 +25,7 @@
 
 @RequiredArgsConstructor
 public class FirebaseAuthFilter extends OncePerRequestFilter {
-    private static final String AUTH = "/auth/ativar";
+    private static final String AUTH = "/api/v1/auth/ativar";
     private final FirebaseUtils utils;
     private final ObjectMapper mapper;
 

src/main/java/br/com/acta/common/config/swagger/annotation/ApiAuthenticationResponses.java

@@ -0,0 +1,31 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponses({
+        @ApiResponse(
+                responseCode = "401",
+                description = "ID Token do Firebase ausente ou inválido",
+                content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_401))
+        ),
+        @ApiResponse(
+                responseCode = "403",
+                description = "Usuário sem permissão para acessar o recurso",
+                content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_403))
+        )
+})
+public @interface ApiAuthenticationResponses {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiBadRequestResponse.java

@@ -0,0 +1,23 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponse(
+        responseCode = "400",
+        description = "Requisição inválida",
+        content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_400))
+)
+public @interface ApiBadRequestResponse {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiBusinessRuleResponse.java

@@ -0,0 +1,23 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponse(
+        responseCode = "422",
+        description = "Regra de negócio não atendida",
+        content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_422))
+)
+public @interface ApiBusinessRuleResponse {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiConflictResponse.java

@@ -0,0 +1,23 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponse(
+        responseCode = "409",
+        description = "Conflito com os dados existentes",
+        content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_409))
+)
+public @interface ApiConflictResponse {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiNotFoundResponse.java

@@ -0,0 +1,23 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponse(
+        responseCode = "404",
+        description = "Recurso não encontrado",
+        content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_404))
+)
+public @interface ApiNotFoundResponse {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiResourceResponses.java

@@ -0,0 +1,15 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@ApiAuthenticationResponses
+@ApiBadRequestResponse
+@ApiNotFoundResponse
+@ApiConflictResponse
+public @interface ApiResourceResponses {
+}

src/main/java/br/com/acta/common/config/swagger/annotation/ApiUnsupportedMediaTypeResponse.java

@@ -0,0 +1,23 @@
+package br.com.acta.common.config.swagger.annotation;
+
+import br.com.acta.common.config.swagger.examples.SwaggerResponseExamples;
+import br.com.acta.common.handler.ErroResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@ApiResponse(
+        responseCode = "415",
+        description = "Tipo de conteúdo enviado não suportado",
+        content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErroResponse.class), examples = @ExampleObject(value = SwaggerResponseExamples.ERRO_415))
+)
+public @interface ApiUnsupportedMediaTypeResponse {
+}