Skip to content

Commit 2e40e82

Browse files
jpfinnejpfinne
committed
Add sample for useDeductionForOneOfInterfaces=true
1 parent 09a00b6 commit 2e40e82

40 files changed

Lines changed: 3436 additions & 0 deletions

‎bin/configs/spring-boot-oneof-interface.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
generatorName: spring
2+
outputDir: samples/openapi3/server/petstore/spring-boot-oneof-interface
3+
inputSpec: modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml
4+
templateDir: modules/openapi-generator/src/main/resources/JavaSpring
5+
additionalProperties:
6+
groupId: org.openapitools.openapi3
7+
documentationProvider: springdoc
8+
artifactId: springboot-oneof
9+
snapshotVersion: "true"
10+
hideGenerationTimestamp: "true"
11+
useOneOfInterfaces: "true"
12+
useDeductionForOneOfInterfaces: "true"

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/.openapi-generator-ignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# OpenAPI Generator Ignore
2+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/.openapi-generator/FILES‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
README.md
2+
pom.xml
3+
src/main/java/org/openapitools/OpenApiGeneratorApplication.java
4+
src/main/java/org/openapitools/RFC3339DateFormat.java
5+
src/main/java/org/openapitools/api/ApiUtil.java
6+
src/main/java/org/openapitools/api/BarApi.java
7+
src/main/java/org/openapitools/api/FooApi.java
8+
src/main/java/org/openapitools/configuration/EnumConverterConfiguration.java
9+
src/main/java/org/openapitools/configuration/HomeController.java
10+
src/main/java/org/openapitools/configuration/SpringDocConfiguration.java
11+
src/main/java/org/openapitools/model/Addressable.java
12+
src/main/java/org/openapitools/model/Animal.java
13+
src/main/java/org/openapitools/model/Apple.java
14+
src/main/java/org/openapitools/model/Banana.java
15+
src/main/java/org/openapitools/model/Bar.java
16+
src/main/java/org/openapitools/model/BarCreate.java
17+
src/main/java/org/openapitools/model/BarRef.java
18+
src/main/java/org/openapitools/model/BarRefOrValue.java
19+
src/main/java/org/openapitools/model/Cat.java
20+
src/main/java/org/openapitools/model/Dog.java
21+
src/main/java/org/openapitools/model/Entity.java
22+
src/main/java/org/openapitools/model/EntityRef.java
23+
src/main/java/org/openapitools/model/Extensible.java
24+
src/main/java/org/openapitools/model/Foo.java
25+
src/main/java/org/openapitools/model/FooRef.java
26+
src/main/java/org/openapitools/model/FooRefOrValue.java
27+
src/main/java/org/openapitools/model/Fruit.java
28+
src/main/java/org/openapitools/model/FruitType.java
29+
src/main/java/org/openapitools/model/Pasta.java
30+
src/main/java/org/openapitools/model/Pizza.java
31+
src/main/java/org/openapitools/model/PizzaSpeziale.java
32+
src/main/resources/application.properties
33+
src/main/resources/openapi.yaml
34+
src/test/java/org/openapitools/OpenApiGeneratorApplicationTests.java

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/.openapi-generator/VERSION‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
7.13.0-SNAPSHOT

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# OpenAPI generated server
2+
3+
Spring Boot Server
4+
5+
## Overview
6+
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
7+
By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
8+
This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
9+
10+
11+
The underlying library integrating OpenAPI to Spring Boot is [springdoc](https://springdoc.org).
12+
Springdoc will generate an OpenAPI v3 specification based on the generated Controller and Model classes.
13+
The specification is available to download using the following url:
14+
http://localhost:8080/v3/api-docs/
15+
16+
Start your server as a simple java application
17+
18+
You can view the api documentation in swagger-ui by pointing to
19+
http://localhost:8080/swagger-ui.html
20+
21+
Change default port value in application.properties

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/pom.xml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
2+
<modelVersion>4.0.0</modelVersion>
3+
<groupId>org.openapitools.openapi3</groupId>
4+
<artifactId>springboot-oneof</artifactId>
5+
<packaging>jar</packaging>
6+
<name>springboot-oneof</name>
7+
<version>0.0.1-SNAPSHOT</version>
8+
<properties>
9+
<java.version>1.8</java.version>
10+
<maven.compiler.source>${java.version}</maven.compiler.source>
11+
<maven.compiler.target>${java.version}</maven.compiler.target>
12+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
13+
<springdoc.version>1.6.14</springdoc.version>
14+
<swagger-ui.version>5.3.1</swagger-ui.version>
15+
</properties>
16+
<parent>
17+
<groupId>org.springframework.boot</groupId>
18+
<artifactId>spring-boot-starter-parent</artifactId>
19+
<version>2.7.15</version>
20+
<relativePath/> <!-- lookup parent from repository -->
21+
</parent>
22+
<build>
23+
<sourceDirectory>src/main/java</sourceDirectory>
24+
<plugins>
25+
<plugin>
26+
<groupId>org.springframework.boot</groupId>
27+
<artifactId>spring-boot-maven-plugin</artifactId>
28+
<configuration>
29+
</configuration>
30+
</plugin>
31+
</plugins>
32+
</build>
33+
<dependencies>
34+
<dependency>
35+
<groupId>org.springframework.boot</groupId>
36+
<artifactId>spring-boot-starter-web</artifactId>
37+
</dependency>
38+
<dependency>
39+
<groupId>org.springframework.data</groupId>
40+
<artifactId>spring-data-commons</artifactId>
41+
</dependency>
42+
<!--SpringDoc dependencies -->
43+
<dependency>
44+
<groupId>org.springdoc</groupId>
45+
<artifactId>springdoc-openapi-ui</artifactId>
46+
<version>${springdoc.version}</version>
47+
</dependency>
48+
<!-- @Nullable annotation -->
49+
<dependency>
50+
<groupId>com.google.code.findbugs</groupId>
51+
<artifactId>jsr305</artifactId>
52+
<version>3.0.2</version>
53+
</dependency>
54+
<dependency>
55+
<groupId>com.fasterxml.jackson.dataformat</groupId>
56+
<artifactId>jackson-dataformat-yaml</artifactId>
57+
</dependency>
58+
<dependency>
59+
<groupId>com.fasterxml.jackson.datatype</groupId>
60+
<artifactId>jackson-datatype-jsr310</artifactId>
61+
</dependency>
62+
<dependency>
63+
<groupId>org.openapitools</groupId>
64+
<artifactId>jackson-databind-nullable</artifactId>
65+
<version>0.2.6</version>
66+
</dependency>
67+
<!-- Bean Validation API support -->
68+
<dependency>
69+
<groupId>org.springframework.boot</groupId>
70+
<artifactId>spring-boot-starter-validation</artifactId>
71+
</dependency>
72+
<dependency>
73+
<groupId>com.fasterxml.jackson.core</groupId>
74+
<artifactId>jackson-databind</artifactId>
75+
</dependency>
76+
<dependency>
77+
<groupId>org.springframework.boot</groupId>
78+
<artifactId>spring-boot-starter-test</artifactId>
79+
<scope>test</scope>
80+
</dependency>
81+
</dependencies>
82+
</project>

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/OpenApiGeneratorApplication.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package org.openapitools;
2+
3+
import com.fasterxml.jackson.databind.Module;
4+
import org.openapitools.jackson.nullable.JsonNullableModule;
5+
import org.springframework.boot.SpringApplication;
6+
import org.springframework.boot.autoconfigure.SpringBootApplication;
7+
import org.springframework.context.annotation.Bean;
8+
import org.springframework.context.annotation.ComponentScan;
9+
import org.springframework.context.annotation.FilterType;
10+
import org.springframework.context.annotation.FullyQualifiedAnnotationBeanNameGenerator;
11+
12+
@SpringBootApplication(
13+
nameGenerator = FullyQualifiedAnnotationBeanNameGenerator.class
14+
)
15+
@ComponentScan(
16+
basePackages = {"org.openapitools", "org.openapitools.api" , "org.openapitools.configuration"},
17+
nameGenerator = FullyQualifiedAnnotationBeanNameGenerator.class
18+
)
19+
public class OpenApiGeneratorApplication {
20+
21+
public static void main(String[] args) {
22+
SpringApplication.run(OpenApiGeneratorApplication.class, args);
23+
}
24+
25+
@Bean(name = "org.openapitools.OpenApiGeneratorApplication.jsonNullableModule")
26+
public Module jsonNullableModule() {
27+
return new JsonNullableModule();
28+
}
29+
30+
}

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/RFC3339DateFormat.java‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package org.openapitools;
2+
3+
import com.fasterxml.jackson.databind.util.StdDateFormat;
4+
5+
import java.text.DateFormat;
6+
import java.text.FieldPosition;
7+
import java.text.ParsePosition;
8+
import java.util.Date;
9+
import java.util.GregorianCalendar;
10+
import java.util.TimeZone;
11+
12+
public class RFC3339DateFormat extends DateFormat {
13+
private static final long serialVersionUID = 1L;
14+
private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC");
15+
16+
private final StdDateFormat fmt = new StdDateFormat()
17+
.withTimeZone(TIMEZONE_Z)
18+
.withColonInTimeZone(true);
19+
20+
public RFC3339DateFormat() {
21+
this.calendar = new GregorianCalendar();
22+
}
23+
24+
@Override
25+
public Date parse(String source, ParsePosition pos) {
26+
return fmt.parse(source, pos);
27+
}
28+
29+
@Override
30+
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) {
31+
return fmt.format(date, toAppendTo, fieldPosition);
32+
}
33+
34+
@Override
35+
public Object clone() {
36+
return this;
37+
}
38+
}

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/ApiUtil.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package org.openapitools.api;
2+
3+
import org.springframework.web.context.request.NativeWebRequest;
4+
5+
import javax.servlet.http.HttpServletResponse;
6+
import java.io.IOException;
7+
8+
public class ApiUtil {
9+
public static void setExampleResponse(NativeWebRequest req, String contentType, String example) {
10+
try {
11+
HttpServletResponse res = req.getNativeResponse(HttpServletResponse.class);
12+
res.setCharacterEncoding("UTF-8");
13+
res.addHeader("Content-Type", contentType);
14+
res.getWriter().print(example);
15+
} catch (IOException e) {
16+
throw new RuntimeException(e);
17+
}
18+
}
19+
}

‎samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/api/BarApi.java‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/**
2+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech) (7.13.0-SNAPSHOT).
3+
* https://openapi-generator.tech
4+
* Do not edit the class manually.
5+
*/
6+
package org.openapitools.api;
7+
8+
import org.openapitools.model.Bar;
9+
import org.openapitools.model.BarCreate;
10+
import io.swagger.v3.oas.annotations.ExternalDocumentation;
11+
import io.swagger.v3.oas.annotations.Operation;
12+
import io.swagger.v3.oas.annotations.Parameter;
13+
import io.swagger.v3.oas.annotations.Parameters;
14+
import io.swagger.v3.oas.annotations.media.ArraySchema;
15+
import io.swagger.v3.oas.annotations.media.Content;
16+
import io.swagger.v3.oas.annotations.media.Schema;
17+
import io.swagger.v3.oas.annotations.responses.ApiResponse;
18+
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
19+
import io.swagger.v3.oas.annotations.tags.Tag;
20+
import io.swagger.v3.oas.annotations.enums.ParameterIn;
21+
import org.springframework.http.HttpStatus;
22+
import org.springframework.http.MediaType;
23+
import org.springframework.http.ResponseEntity;
24+
import org.springframework.validation.annotation.Validated;
25+
import org.springframework.web.bind.annotation.*;
26+
import org.springframework.web.context.request.NativeWebRequest;
27+
import org.springframework.web.multipart.MultipartFile;
28+
29+
import javax.validation.Valid;
30+
import javax.validation.constraints.*;
31+
import java.util.List;
32+
import java.util.Map;
33+
import java.util.Optional;
34+
import javax.annotation.Generated;
35+
36+
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.13.0-SNAPSHOT")
37+
@Validated
38+
@Tag(name = "Bar", description = "the Bar API")
39+
public interface BarApi {
40+
41+
default Optional<NativeWebRequest> getRequest() {
42+
return Optional.empty();
43+
}
44+
45+
/**
46+
* POST /bar : Create a Bar
47+
*
48+
* @param barCreate (required)
49+
* @return Bar created (status code 200)
50+
*/
51+
@Operation(
52+
operationId = "createBar",
53+
summary = "Create a Bar",
54+
tags = { "Bar" },
55+
responses = {
56+
@ApiResponse(responseCode = "200", description = "Bar created", content = {
57+
@Content(mediaType = "application/json", schema = @Schema(implementation = Bar.class))
58+
})
59+
}
60+
)
61+
@RequestMapping(
62+
method = RequestMethod.POST,
63+
value = "/bar",
64+
produces = { "application/json" },
65+
consumes = { "application/json" }
66+
)
67+
68+
default ResponseEntity<Bar> createBar(
69+
@Parameter(name = "BarCreate", description = "", required = true) @Valid @RequestBody BarCreate barCreate
70+
) {
71+
getRequest().ifPresent(request -> {
72+
for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
73+
if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
74+
String exampleString = "{ \"foo\" : { \"fooPropA\" : \"fooPropA\", \"fooPropB\" : \"fooPropB\" }, \"id\" : \"id\", \"fooPropB\" : \"fooPropB\", \"barPropA\" : \"barPropA\" }";
75+
ApiUtil.setExampleResponse(request, "application/json", exampleString);
76+
break;
77+
}
78+
}
79+
});
80+
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
81+
82+
}
83+
84+
}

0 commit comments

Comments
 (0)