mavend investigation

Author: jpfinne

bin/configs/spring-boot-4-jspecify.yaml

@@ -7,7 +7,7 @@ validateSpec: false
 additionalProperties:
   groupId: org.openapitools.openapi3
   documentationProvider: springdoc
-  interfaceOnly: true
+#  interfaceOnly: true
   artifactId: springboot
   snapshotVersion: "true"
   useSpringBoot4: true

samples/openapi3/server/petstore/springboot-4-jspecify/.openapi-generator/FILES

@@ -1,8 +1,17 @@
 README.md
 pom.xml
+src/main/java/org/openapitools/OpenApiGeneratorApplication.java
+src/main/java/org/openapitools/RFC3339DateFormat.java
 src/main/java/org/openapitools/api/ApiUtil.java
 src/main/java/org/openapitools/api/FooApi.java
+src/main/java/org/openapitools/api/FooApiController.java
 src/main/java/org/openapitools/api/UploadApi.java
+src/main/java/org/openapitools/api/UploadApiController.java
 src/main/java/org/openapitools/api/package-info.java
+src/main/java/org/openapitools/configuration/HomeController.java
+src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
 src/main/java/org/openapitools/model/Foo.java
 src/main/java/org/openapitools/model/package-info.java
+src/main/resources/application.properties
+src/main/resources/openapi.yaml
+src/test/java/org/openapitools/OpenApiGeneratorApplicationTests.java

samples/openapi3/server/petstore/springboot-4-jspecify/README.md

@@ -1,27 +1,21 @@
+# OpenAPI generated server
 
-# OpenAPI generated API stub
+Spring Boot Server
 
-Spring Framework stub
+## Overview
+This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
+This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
 
 
-## Overview
-This code was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
-By using the [OpenAPI-Spec](https://openapis.org), you can easily generate an API stub.
-This is an example of building API stub interfaces in Java using the Spring framework.
+The underlying library integrating OpenAPI to Spring Boot is [springdoc](https://springdoc.org).
+Springdoc will generate an OpenAPI v3 specification based on the generated Controller and Model classes.
+The specification is available to download using the following url:
+http://localhost:8080/v3/api-docs/
 
-The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
-by adding ```@Controller``` classes that implement the interface. Eg:
-```java
-@Controller
-public class PetController implements PetApi {
-// implement all PetApi methods
-}
-```
+Start your server as a simple java application
 
-You can also use the interface to create [Spring-Cloud Feign clients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).Eg:
-```java
-@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
-public interface PetClient extends PetApi {
+You can view the api documentation in swagger-ui by pointing to
+http://localhost:8080/swagger-ui.html
 
-}
-```
+Change default port value in application.properties

samples/openapi3/server/petstore/springboot-4-jspecify/pom.xml

@@ -23,16 +23,10 @@
         <sourceDirectory>src/main/java</sourceDirectory>
         <plugins>
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-source-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>attach-sources</id>
-                        <goals>
-                            <goal>jar</goal>
-                        </goals>
-                    </execution>
-                </executions>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                </configuration>
             </plugin>
         </plugins>
     </build>

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/OpenApiGeneratorApplication.java

@@ -0,0 +1,24 @@
+package org.openapitools;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.FilterType;
+import org.springframework.context.annotation.FullyQualifiedAnnotationBeanNameGenerator;
+
+@SpringBootApplication(
+    nameGenerator = FullyQualifiedAnnotationBeanNameGenerator.class
+)
+@ComponentScan(
+    basePackages = {"org.openapitools", "org.openapitools.api" , "org.openapitools.configuration"},
+    nameGenerator = FullyQualifiedAnnotationBeanNameGenerator.class
+)
+public class OpenApiGeneratorApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(OpenApiGeneratorApplication.class, args);
+    }
+
+
+}

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/RFC3339DateFormat.java

@@ -0,0 +1,38 @@
+package org.openapitools;
+
+import tools.jackson.databind.util.StdDateFormat;
+
+import java.text.DateFormat;
+import java.text.FieldPosition;
+import java.text.ParsePosition;
+import java.util.Date;
+import java.util.GregorianCalendar;
+import java.util.TimeZone;
+
+public class RFC3339DateFormat extends DateFormat {
+  private static final long serialVersionUID = 1L;
+  private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC");
+
+  private final StdDateFormat fmt = new StdDateFormat()
+          .withTimeZone(TIMEZONE_Z)
+          .withColonInTimeZone(true);
+
+  public RFC3339DateFormat() {
+    this.calendar = new GregorianCalendar();
+  }
+
+  @Override
+  public Date parse(String source, ParsePosition pos) {
+    return fmt.parse(source, pos);
+  }
+
+  @Override
+  public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) {
+    return fmt.format(date, toAppendTo, fieldPosition);
+  }
+
+  @Override
+  public Object clone() {
+    return this;
+  }
+}

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/FooApiController.java

@@ -0,0 +1,50 @@
+package org.openapitools.api;
+
+import org.springframework.format.annotation.DateTimeFormat;
+import org.openapitools.model.Foo;
+import org.jspecify.annotations.Nullable;
+import java.time.OffsetDateTime;
+
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.CookieValue;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
+import org.springframework.web.multipart.MultipartFile;
+import org.springframework.web.context.request.NativeWebRequest;
+
+import jakarta.validation.constraints.*;
+import jakarta.validation.Valid;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import jakarta.annotation.Generated;
+
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.21.0-SNAPSHOT")
+@Controller
+@RequestMapping("${openapi.jspecify.base-path:}")
+public class FooApiController implements FooApi {
+
+    @Nullable
+    private final NativeWebRequest request;
+
+    @Autowired
+    public FooApiController(@Nullable NativeWebRequest request) {
+        this.request = request;
+    }
+
+    @Override
+    public Optional<NativeWebRequest> getRequest() {
+        return Optional.ofNullable(request);
+    }
+
+}

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/api/UploadApiController.java

@@ -0,0 +1,47 @@
+package org.openapitools.api;
+
+import org.jspecify.annotations.Nullable;
+
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.CookieValue;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
+import org.springframework.web.multipart.MultipartFile;
+import org.springframework.web.context.request.NativeWebRequest;
+
+import jakarta.validation.constraints.*;
+import jakarta.validation.Valid;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import jakarta.annotation.Generated;
+
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.21.0-SNAPSHOT")
+@Controller
+@RequestMapping("${openapi.jspecify.base-path:}")
+public class UploadApiController implements UploadApi {
+
+    @Nullable
+    private final NativeWebRequest request;
+
+    @Autowired
+    public UploadApiController(@Nullable NativeWebRequest request) {
+        this.request = request;
+    }
+
+    @Override
+    public Optional<NativeWebRequest> getRequest() {
+        return Optional.ofNullable(request);
+    }
+
+}

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/configuration/HomeController.java

@@ -0,0 +1,20 @@
+package org.openapitools.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.GetMapping;
+
+/**
+ * Home redirection to OpenAPI api documentation
+ */
+@Controller
+public class HomeController {
+
+    @RequestMapping("/")
+    public String index() {
+        return "redirect:swagger-ui.html";
+    }
+
+}

samples/openapi3/server/petstore/springboot-4-jspecify/src/main/java/org/openapitools/configuration/SpringDocConfiguration.java

@@ -0,0 +1,27 @@
+package org.openapitools.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+
+@Configuration
+public class SpringDocConfiguration {
+
+    @Bean(name = "org.openapitools.configuration.SpringDocConfiguration.apiInfo")
+    OpenAPI apiInfo() {
+        return new OpenAPI()
+                .info(
+                        new Info()
+                                .title("jspecify")
+                                .description("test fully qualified name and jspecify")
+                                .version("1.0.0")
+                )
+        ;
+    }
+}