genspeccia

Opetushallitus · Dec 9, 2024 · 85326b8 · 85326b8
1 parent b135faf
commit 85326b8
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 4 deletions.
diff --git a/eperusteet/eperusteet-service/pom.xml b/eperusteet/eperusteet-service/pom.xml
@@ -45,7 +45,7 @@
 <!--        <springfox.version>2.7.0</springfox.version>-->
         <springdoc.version>2.7.0</springdoc.version>
         <surefire.version>3.2.2</surefire.version>
-        <swagger-maven-plugin-version>3.1.7</swagger-maven-plugin-version>
+        <swagger-maven-plugin-version>3.1.8</swagger-maven-plugin-version>
         <jacoco.version>0.8.12</jacoco.version>
     </properties>
     <dependencies>
@@ -94,7 +94,13 @@
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
             <version>${springdoc.version}</version>
         </dependency>
-<!--        <dependency>-->
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-common</artifactId>
+            <version>1.8.0</version>
+        </dependency>
+
+        <!--        <dependency>-->
 <!--            <groupId>io.springfox</groupId>-->
 <!--            <artifactId>springfox-swagger2</artifactId>-->
 <!--            <version>${springfox.version}</version>-->
@@ -984,7 +990,7 @@
                         </executions>
                         <configuration>
                             <apiDocsUrl>http://localhost:8080/eperusteet-service/api-docs</apiDocsUrl>
-                            <outputFileName>eperusteet.json</outputFileName>
+                            <outputFileName>eperusteet.spec.json</outputFileName>
                             <outputDir>${project.build.directory}/openapi</outputDir>
                         </configuration>
                     </plugin>

diff --git a/eperusteet/eperusteet-service/src/main/java/fi/vm/sade/eperusteet/config/SwaggerConfig.java b/eperusteet/eperusteet-service/src/main/java/fi/vm/sade/eperusteet/config/SwaggerConfig.java
@@ -1,12 +1,17 @@
 package fi.vm.sade.eperusteet.config;
 
+import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.media.Schema;
+import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
 
+import java.util.Map;
+
 @Configuration
 //@EnableSwagger2
 @Profile("!test")
@@ -50,4 +55,28 @@ public OpenAPI springShopOpenAPI() {
                         .version("v3.0.0")
                         .license(new License().name("EUPL 1.1").url("https://interoperable-europe.ec.europa.eu/licence/european-union-public-licence-version-11-or-later-eupl")));
     }
+
+//    @Bean
+//    public OpenApiCustomiser customOpenApi() {
+//        return openApi -> {
+//            Components components = openApi.getComponents();
+//            if (components != null && components.getSchemas() != null) {
+//                Map<String, Schema> schemas = components.getSchemas();
+//
+//                for (Schema<?> schema : schemas.values()) {
+//                    if (schema.getProperties() != null) {
+//                        schema.getProperties().forEach((propertyName, propertySchema) -> {
+//                            if (propertySchema instanceof Schema) {
+//                                Schema<?> property = (Schema<?>) propertySchema;
+//
+//                                if ("array".equals(property.getType())) {
+//                                    property.setUniqueItems(null);
+//                                }
+//                            }
+//                        });
+//                    }
+//                }
+//            }
+//        };
+//    }
 }
diff --git a/...t/eperusteet-service/src/main/java/fi/vm/sade/eperusteet/dto/peruste/PerusteKevytDto.java b/...t/eperusteet-service/src/main/java/fi/vm/sade/eperusteet/dto/peruste/PerusteKevytDto.java
@@ -7,6 +7,8 @@
 import fi.vm.sade.eperusteet.dto.util.LokalisoituTekstiDto;
 import java.util.Date;
 
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -28,5 +30,6 @@ public class PerusteKevytDto {
     private Reference perusteprojekti;
 
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
+//    @Schema(type = "array")
     private Set<SuoritustapaDto> suoritustavat;
 }
diff --git a/...rusteet-service/src/main/java/fi/vm/sade/eperusteet/dto/peruste/PerusteenOsaViiteDto.java b/...rusteet-service/src/main/java/fi/vm/sade/eperusteet/dto/peruste/PerusteenOsaViiteDto.java
@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import fi.vm.sade.eperusteet.dto.Reference;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
@@ -15,6 +16,7 @@
 @NoArgsConstructor
 @AllArgsConstructor
 @JsonInclude(Include.NON_NULL)
+@Schema(name = "PerusteenOsaViiteDto")
 public class PerusteenOsaViiteDto<R extends PerusteenOsaDto> {
 
     private Long id;
@@ -44,6 +46,7 @@ public Matala(PerusteenOsaDto.Laaja perusteenOsa) {
     @EqualsAndHashCode(callSuper = true)
     @NoArgsConstructor
     @AllArgsConstructor
+    @Schema(name = "PuuPerusteenOsaDto")
     public static class Puu<R extends PerusteenOsaDto, L extends Puu<R, L>> extends PerusteenOsaViiteDto<R> {
         private List<L> lapset;
     }

diff --git a/eperusteet/eperusteet-service/src/main/resources/application.properties b/eperusteet/eperusteet-service/src/main/resources/application.properties
@@ -50,4 +50,6 @@ springdoc.packagesToScan=fi.vm.sade.eperusteet.resource
 springdoc.pathsToMatch=/api/**
 springdoc.swagger-ui.disable-swagger-default-url=true
 springdoc.swagger-ui.path=/swagger
-springdoc.api-docs.path=/api-docs
+springdoc.api-docs.path=/api-docs
+
+#openapi.generator.maven.plugin.instantiationTypes=array=ArrayList