Merge pull request #11 from aboutbits/ab-253-extract-swagger-utilities-to-our-backend-lib

Ab 253 extract swagger utilities to our backend lib

Author: SirCotare

pom.xml

@@ -36,6 +36,11 @@
             <artifactId>spring-boot-starter-json</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.security</groupId>
+            <artifactId>spring-security-core</artifactId>
+        </dependency>
+
         <!-- Utilities -->
         <dependency>
             <groupId>org.projectlombok</groupId>

src/main/java/it/aboutbits/springboot/toolbox/autoconfiguration/swagger/RegisterCustomTypesWithSwagger.java

@@ -1,7 +1,7 @@
 package it.aboutbits.springboot.toolbox.autoconfiguration.swagger;
 
-import it.aboutbits.springboot.toolbox.swagger.CustomTypeModelConverter;
-import it.aboutbits.springboot.toolbox.swagger.CustomTypePropertyCustomizer;
+import it.aboutbits.springboot.toolbox.swagger.type.CustomTypeModelConverter;
+import it.aboutbits.springboot.toolbox.swagger.type.CustomTypePropertyCustomizer;
 import org.springframework.context.annotation.Import;
 
 import java.lang.annotation.ElementType;

src/main/java/it/aboutbits/springboot/toolbox/mvc/response/ErrorResponse.java

@@ -0,0 +1,13 @@
+package it.aboutbits.springboot.toolbox.mvc.response;
+
+import org.springframework.lang.Nullable;
+
+import java.util.List;
+import java.util.Map;
+
+public record ErrorResponse(
+        @Nullable String message,
+        @Nullable Map<String, List<String>> errors
+) {
+
+}

src/main/java/it/aboutbits/springboot/toolbox/mvc/response/ItemResponse.java

@@ -0,0 +1,6 @@
+package it.aboutbits.springboot.toolbox.mvc.response;
+
+import lombok.NonNull;
+
+public record ItemResponse<T>(@NonNull T data) {
+}

src/main/java/it/aboutbits/springboot/toolbox/mvc/response/ListResponse.java

@@ -0,0 +1,8 @@
+package it.aboutbits.springboot.toolbox.mvc.response;
+
+import lombok.NonNull;
+
+import java.util.List;
+
+public record ListResponse<T>(@NonNull List<T> data) {
+}

src/main/java/it/aboutbits/springboot/toolbox/mvc/response/PagedResponse.java

@@ -0,0 +1,29 @@
+package it.aboutbits.springboot.toolbox.mvc.response;
+
+import lombok.NonNull;
+import org.springframework.data.domain.Page;
+
+import java.util.List;
+
+public record PagedResponse<T>(
+        @NonNull
+        List<T> data,
+        @NonNull
+        MetaWithPagination meta
+) {
+
+    public record MetaWithPagination(
+            @NonNull
+            Pagination pagination
+    ) {
+        public record Pagination(long page, int size, long totalElements) {
+            public static Pagination of(@NonNull Page<?> page) {
+                return new Pagination(
+                        page.getNumber(),
+                        page.getSize(),
+                        page.getTotalElements()
+                );
+            }
+        }
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/swagger/annotations/SwaggerScopedAuth.java

@@ -0,0 +1,12 @@
+package it.aboutbits.springboot.toolbox.swagger.annotations;
+
+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)
+public @interface SwaggerScopedAuth {
+    String value();
+}

src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/alphabetical_model_order/OrderModelsCustomizer.java

@@ -0,0 +1,15 @@
+package it.aboutbits.springboot.toolbox.swagger.customization.alphabetical_model_order;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import org.springdoc.core.customizers.OpenApiCustomizer;
+
+import java.util.TreeMap;
+
+public class OrderModelsCustomizer implements OpenApiCustomizer {
+    @Override
+    public void customise(OpenAPI openApi) {
+        var components = openApi.getComponents();
+
+        components.schemas(new TreeMap<>(components.getSchemas()));
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/authorization_docs/AuthorizationDescriptor.java

@@ -0,0 +1,50 @@
+package it.aboutbits.springboot.toolbox.swagger.customization.authorization_docs;
+
+import io.swagger.v3.oas.models.Operation;
+import it.aboutbits.springboot.toolbox.swagger.annotations.SwaggerScopedAuth;
+import lombok.extern.slf4j.Slf4j;
+import org.springdoc.core.customizers.OperationCustomizer;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.web.method.HandlerMethod;
+
+import java.util.ArrayList;
+import java.util.Optional;
+
+@Slf4j
+public class AuthorizationDescriptor implements OperationCustomizer {
+    @Override
+    public Operation customize(Operation operation, HandlerMethod handlerMethod) {
+        try {
+            var additionalDescription = new ArrayList<String>();
+
+            var maybeAnnotation = Optional.ofNullable(handlerMethod.getMethodAnnotation(PreAuthorize.class));
+            if (maybeAnnotation.isPresent()) {
+                var annotation = maybeAnnotation.get();
+                additionalDescription.add("<b>Authorization:</b> " + annotation.value());
+            }
+
+            var maybeAnnotation2 = Optional.ofNullable(handlerMethod.getMethodAnnotation(SwaggerScopedAuth.class));
+            if (maybeAnnotation2.isPresent()) {
+                var annotation = maybeAnnotation2.get();
+                additionalDescription.add("<b>Scoped Authorization:</b> " + annotation.value());
+            }
+
+            if (!additionalDescription.isEmpty()) {
+
+                var currentDescription = Optional.ofNullable(operation.getDescription());
+
+                var description = String.join("<br />", additionalDescription);
+                if (currentDescription.isPresent()) {
+                    description = "<p>" + description + "</p>" + currentDescription.get();
+                }
+
+                operation.description(
+                        description
+                );
+            }
+        } catch (Exception e) {
+            log.error("Error when creating swagger documentation for authorities.", e);
+        }
+        return operation;
+    }
+}

src/main/java/it/aboutbits/springboot/toolbox/swagger/customization/default_not_null/NullableCustomizer.java

@@ -0,0 +1,24 @@
+package it.aboutbits.springboot.toolbox.swagger.customization.default_not_null;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.media.Schema;
+import org.springdoc.core.customizers.OpenApiCustomizer;
+
+import java.util.ArrayList;
+
+public class NullableCustomizer implements OpenApiCustomizer {
+    @Override
+    @SuppressWarnings("unchecked")
+    public void customise(OpenAPI openApi) {
+        openApi.getComponents().getSchemas().values()
+                .forEach(schema -> {
+                    var requiredProperties = new ArrayList<String>();
+                    ((Schema<?>) schema).getProperties().forEach((propertyName, property) -> {
+                        if (property.getNullable() == null || !property.getNullable()) {
+                            requiredProperties.add(propertyName);
+                        }
+                    });
+                    schema.setRequired(requiredProperties);
+                });
+    }
+}