mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2026-02-17 15:30:56 +00:00
Compare commits
54 Commits
wing328-pa
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9432aaf4a3 | ||
|
|
bd7fc7f45f | ||
|
|
67a637fe8d | ||
|
|
561aa2e107 | ||
|
|
ff7fd36876 | ||
|
|
b1022e7a7e | ||
|
|
f9f411945d | ||
|
|
5a70edb063 | ||
|
|
2a2e470165 | ||
|
|
fffc21e3ee | ||
|
|
3d05d5aa9a | ||
|
|
73dcdd6976 | ||
|
|
a8ccfad285 | ||
|
|
3c092b4c30 | ||
|
|
45c3692fa0 | ||
|
|
4a17fcd007 | ||
|
|
1e71920d2b | ||
|
|
5e5ef12f86 | ||
|
|
e086c300ca | ||
|
|
1c25f2c39c | ||
|
|
8d998bf90c | ||
|
|
a53ebb3ad2 | ||
|
|
aeea8b1254 | ||
|
|
b96334ffad | ||
|
|
d47ab0f545 | ||
|
|
c804b46f0c | ||
|
|
96bfa522fb | ||
|
|
893e220fec | ||
|
|
b39aad0d56 | ||
|
|
33cce11a1d | ||
|
|
f5b4850cab | ||
|
|
6b7c3d069e | ||
|
|
a7d57cafff | ||
|
|
8d88b8219d | ||
|
|
2ee50ce900 | ||
|
|
c18015cccd | ||
|
|
7eeab03a57 | ||
|
|
59042aa647 | ||
|
|
d81b0524af | ||
|
|
54fe232d67 | ||
|
|
459f359bf4 | ||
|
|
07d60e010a | ||
|
|
38f0796759 | ||
|
|
561e5bf9ab | ||
|
|
9547ebdc98 | ||
|
|
48b7c85cd4 | ||
|
|
3ecb49060e | ||
|
|
40a0f6f83d | ||
|
|
a973d91560 | ||
|
|
b07f28604e | ||
|
|
d284a9aef1 | ||
|
|
de3bbd5e4e | ||
|
|
a25bed78cd | ||
|
|
aaa3500419 |
59
.github/workflows/samples-cpp-httplib-server.yaml
vendored
Normal file
59
.github/workflows/samples-cpp-httplib-server.yaml
vendored
Normal file
@@ -0,0 +1,59 @@
|
||||
name: Samples cpp httplib server
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- "samples/server/petstore/cpp-httplib-server/**"
|
||||
- ".github/workflows/samples-cpp-httplib-server.yaml"
|
||||
pull_request:
|
||||
paths:
|
||||
- "samples/server/petstore/cpp-httplib-server/**"
|
||||
- ".github/workflows/samples-cpp-httplib-server.yaml"
|
||||
|
||||
env:
|
||||
GRADLE_VERSION: 6.9
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build cpp httplib server
|
||||
strategy:
|
||||
matrix:
|
||||
sample:
|
||||
- samples/server/petstore/cpp-httplib-server/petstore
|
||||
- samples/server/petstore/cpp-httplib-server/feature-test
|
||||
os:
|
||||
- ubuntu-latest
|
||||
- macOS-latest
|
||||
- windows-latest
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install dependencies (Linux)
|
||||
if: matrix.os == 'ubuntu-latest'
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential libssl-dev zlib1g-dev cmake
|
||||
|
||||
- name: Install dependencies (macOS)
|
||||
if: matrix.os == 'macOS-latest'
|
||||
run: |
|
||||
brew install openssl zlib cmake
|
||||
|
||||
- name: Install dependencies (Windows)
|
||||
if: matrix.os == 'windows-latest'
|
||||
run: |
|
||||
vcpkg install openssl:x64-windows zlib:x64-windows
|
||||
shell: cmd
|
||||
timeout-minutes: 20
|
||||
|
||||
- name: Build
|
||||
working-directory: ${{ matrix.sample }}
|
||||
run: |
|
||||
if [ "${{ matrix.os }}" = "windows-latest" ]; then
|
||||
cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE="C:/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
else
|
||||
cmake -S . -B build
|
||||
fi
|
||||
cmake --build build --verbose
|
||||
shell: bash
|
||||
12
.github/workflows/samples-groovy.yaml
vendored
12
.github/workflows/samples-groovy.yaml
vendored
@@ -20,6 +20,14 @@ jobs:
|
||||
matrix:
|
||||
sample:
|
||||
- samples/client/petstore/groovy
|
||||
services:
|
||||
petstore-api:
|
||||
image: swaggerapi/petstore
|
||||
ports:
|
||||
- 80:8080
|
||||
env:
|
||||
SWAGGER_HOST: http://petstore.swagger.io
|
||||
SWAGGER_BASE_PATH: /v2
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-java@v5
|
||||
@@ -41,6 +49,6 @@ jobs:
|
||||
gradle-version: ${{ env.GRADLE_VERSION }}
|
||||
build-root-directory: ${{ matrix.sample }}
|
||||
arguments: wrapper
|
||||
- name: Build
|
||||
- name: Build & Test
|
||||
working-directory: ${{ matrix.sample }}
|
||||
run: ./gradlew build -x test
|
||||
run: ./gradlew build
|
||||
|
||||
3
.github/workflows/samples-jdk17.yaml
vendored
3
.github/workflows/samples-jdk17.yaml
vendored
@@ -14,6 +14,7 @@ on:
|
||||
- samples/client/petstore/java/microprofile-rest-client-outer-enum/**
|
||||
# servers
|
||||
- samples/openapi3/server/petstore/springboot-3/**
|
||||
- samples/server/petstore/springboot-x-implements-skip/**
|
||||
- samples/server/petstore/java-camel/**
|
||||
- samples/server/petstore/java-helidon-server/v3/mp/**
|
||||
- samples/server/petstore/java-helidon-server/v3/se/**
|
||||
@@ -31,6 +32,7 @@ on:
|
||||
- samples/client/petstore/java/microprofile-rest-client-outer-enum/**
|
||||
# servers
|
||||
- samples/openapi3/server/petstore/springboot-3/**
|
||||
- samples/server/petstore/springboot-x-implements-skip/**
|
||||
- samples/server/petstore/java-camel/**
|
||||
- samples/server/petstore/java-helidon-server/v3/mp/**
|
||||
- samples/server/petstore/java-helidon-server/v3/se/**
|
||||
@@ -54,6 +56,7 @@ jobs:
|
||||
- samples/client/petstore/java/microprofile-rest-client-outer-enum
|
||||
# servers
|
||||
- samples/openapi3/server/petstore/springboot-3
|
||||
- samples/server/petstore/springboot-x-implements-skip
|
||||
- samples/server/petstore/java-camel/
|
||||
- samples/server/petstore/java-helidon-server/v3/mp/
|
||||
- samples/server/petstore/java-helidon-server/v3/se
|
||||
|
||||
@@ -20,6 +20,7 @@ jobs:
|
||||
- samples/client/echo_api/kotlin-jvm-spring-3-restclient
|
||||
- samples/client/echo_api/kotlin-model-prefix-type-mappings
|
||||
- samples/client/echo_api/kotlin-jvm-okhttp
|
||||
- samples/client/echo_api/kotlin-jvm-okhttp-multipart-json
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-java@v5
|
||||
|
||||
@@ -3,6 +3,7 @@ name: Samples Kotlin server (jdk17)
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- 'samples/server/others/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-springboot-3*/**'
|
||||
- 'samples/server/petstore/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server-modelMutable/**'
|
||||
@@ -13,6 +14,7 @@ on:
|
||||
# - samples/server/petstore/kotlin-spring-default/**
|
||||
pull_request:
|
||||
paths:
|
||||
- 'samples/server/others/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-springboot-3*/**'
|
||||
- 'samples/server/petstore/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server-modelMutable/**'
|
||||
@@ -34,6 +36,10 @@ jobs:
|
||||
matrix:
|
||||
sample:
|
||||
# server
|
||||
- samples/server/others/kotlin-server/polymorphism-allof-and-discriminator
|
||||
- samples/server/others/kotlin-server/polymorphism-and-discriminator-disabled-jackson-fix
|
||||
- samples/server/others/kotlin-server/polymorphism-and-discriminator
|
||||
- samples/server/others/kotlin-server/polymorphism
|
||||
- samples/server/petstore/kotlin-server-required-and-nullable-properties
|
||||
- samples/server/petstore/kotlin-springboot-3
|
||||
- samples/server/petstore/kotlin-springboot-3-no-response-entity
|
||||
|
||||
@@ -3,10 +3,12 @@ name: Samples Kotlin server (jdk21)
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- 'samples/server/others/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server-required-and-nullable-properties/**'
|
||||
pull_request:
|
||||
paths:
|
||||
- 'samples/server/others/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server/**'
|
||||
- 'samples/server/petstore/kotlin-server-required-and-nullable-properties/**'
|
||||
|
||||
@@ -21,6 +23,10 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
sample:
|
||||
- samples/server/others/kotlin-server/polymorphism-allof-and-discriminator
|
||||
- samples/server/others/kotlin-server/polymorphism-and-discriminator-disabled-jackson-fix
|
||||
- samples/server/others/kotlin-server/polymorphism-and-discriminator
|
||||
- samples/server/others/kotlin-server/polymorphism
|
||||
- samples/server/petstore/kotlin-server/javalin-6
|
||||
- samples/server/petstore/kotlin-server/ktor
|
||||
- samples/server/petstore/kotlin-server/ktor2
|
||||
|
||||
14
.github/workflows/samples-rust-server.yaml
vendored
14
.github/workflows/samples-rust-server.yaml
vendored
@@ -48,17 +48,22 @@ jobs:
|
||||
run: |
|
||||
set -e
|
||||
|
||||
# Iterate through each example and test various features
|
||||
for package in $(find . -maxdepth 1 -mindepth 1 -type d)
|
||||
# Iterate through each package and test various features
|
||||
for package in $(find output -maxdepth 1 -mindepth 1 -type d)
|
||||
do
|
||||
pushd $package
|
||||
# Not all versions have a server example
|
||||
if test -f examples/server/main.rs; then
|
||||
cargo build --example server --features="server"
|
||||
cargo build --example ${package##*/}-server --features="server"
|
||||
fi
|
||||
# Not all versions have a client example
|
||||
if test -f examples/client/main.rs; then
|
||||
cargo build --example ${package##*/}-client --features="client"
|
||||
fi
|
||||
# Test the CLI works if present
|
||||
if test -f bin/cli.rs; then
|
||||
cargo build --bin ${package##*/} --features cli
|
||||
target/debug/${package##*/} --help
|
||||
../../target/debug/${package##*/} --help
|
||||
fi
|
||||
# Test the validate feature if it exists
|
||||
if cargo read-manifest | grep -q '"validate"'; then
|
||||
@@ -77,4 +82,5 @@ jobs:
|
||||
cargo test
|
||||
cargo clippy
|
||||
cargo doc
|
||||
popd
|
||||
done
|
||||
|
||||
9
.github/workflows/samples-spring-jdk17.yaml
vendored
9
.github/workflows/samples-spring-jdk17.yaml
vendored
@@ -4,7 +4,10 @@ on:
|
||||
push:
|
||||
paths:
|
||||
- samples/openapi3/client/petstore/spring-cloud-3-with-optional
|
||||
- samples/openapi3/client/petstore/spring-cloud-4-with-optional
|
||||
- samples/client/petstore/spring-http-interface-springboot-4
|
||||
- samples/openapi3/server/petstore/springboot-3
|
||||
- samples/openapi3/server/petstore/springboot-4
|
||||
- samples/server/petstore/springboot-api-response-examples
|
||||
- samples/server/petstore/springboot-lombok-data
|
||||
- samples/server/petstore/springboot-lombok-tostring
|
||||
@@ -15,7 +18,10 @@ on:
|
||||
pull_request:
|
||||
paths:
|
||||
- samples/openapi3/client/petstore/spring-cloud-3-with-optional
|
||||
- samples/openapi3/client/petstore/spring-cloud-4-with-optional
|
||||
- samples/client/petstore/spring-http-interface-springboot-4
|
||||
- samples/openapi3/server/petstore/springboot-3
|
||||
- samples/openapi3/server/petstore/springboot-4
|
||||
- samples/server/petstore/springboot-api-response-examples
|
||||
- samples/server/petstore/springboot-lombok-data
|
||||
- samples/server/petstore/springboot-lombok-tostring
|
||||
@@ -33,8 +39,11 @@ jobs:
|
||||
sample:
|
||||
# clients
|
||||
- samples/openapi3/client/petstore/spring-cloud-3-with-optional
|
||||
- samples/openapi3/client/petstore/spring-cloud-4-with-optional
|
||||
- samples/client/petstore/spring-http-interface-springboot-4
|
||||
# servers
|
||||
- samples/openapi3/server/petstore/springboot-3
|
||||
- samples/openapi3/server/petstore/springboot-4
|
||||
- samples/server/petstore/springboot-api-response-examples
|
||||
- samples/server/petstore/springboot-lombok-data
|
||||
- samples/server/petstore/springboot-lombok-tostring
|
||||
|
||||
46
.github/workflows/samples-terraform.yaml
vendored
Normal file
46
.github/workflows/samples-terraform.yaml
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
name: Samples Terraform
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- 'samples/client/petstore/terraform/**'
|
||||
- 'samples/client/petstore/terraform-addpet/**'
|
||||
- 'samples/client/petstore/terraform-server/**'
|
||||
- 'samples/client/others/terraform/**'
|
||||
pull_request:
|
||||
paths:
|
||||
- 'samples/client/petstore/terraform/**'
|
||||
- 'samples/client/petstore/terraform-addpet/**'
|
||||
- 'samples/client/petstore/terraform-server/**'
|
||||
- 'samples/client/others/terraform/**'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build Terraform Provider
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
sample:
|
||||
- samples/client/petstore/terraform/
|
||||
- samples/client/petstore/terraform-addpet/
|
||||
- samples/client/petstore/terraform-server/
|
||||
- samples/client/others/terraform/allof-discriminator/
|
||||
- samples/client/others/terraform/oneof-anyof-required/
|
||||
- samples/client/others/terraform/oneof-discriminator-lookup/
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-go@v6
|
||||
with:
|
||||
go-version: "stable"
|
||||
- run: go version
|
||||
- name: Install Dependencies
|
||||
working-directory: ${{ matrix.sample }}
|
||||
run: |
|
||||
go mod tidy
|
||||
- name: Build provider
|
||||
working-directory: ${{ matrix.sample }}
|
||||
run: go build -v ./...
|
||||
- name: Run tests
|
||||
working-directory: ${{ matrix.sample }}
|
||||
run: go test ./... -v -timeout 120m
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -229,7 +229,9 @@ samples/client/petstore/kotlin*/src/main/kotlin/test/
|
||||
samples/client/petstore/kotlin*/build/
|
||||
samples/server/others/kotlin-server/jaxrs-spec/build/
|
||||
samples/client/echo_api/kotlin-jvm-spring-3-restclient/build/
|
||||
samples/client/echo_api/kotlin-jvm-spring-3-webclient/build/
|
||||
samples/client/echo_api/kotlin-jvm-okhttp/build/
|
||||
samples/client/echo_api/kotlin-jvm-okhttp-multipart-json/build/
|
||||
|
||||
# haskell
|
||||
.stack-work
|
||||
|
||||
34
README.md
34
README.md
@@ -15,7 +15,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[Master](https://github.com/OpenAPITools/openapi-generator/tree/master) (`7.20.0`):
|
||||
[Master](https://github.com/OpenAPITools/openapi-generator/tree/master) (`7.21.0`):
|
||||
[](https://circleci.com/gh/OpenAPITools/openapi-generator)
|
||||
[](https://app.bitrise.io/app/4a2b10a819d12b67)
|
||||
|
||||
@@ -75,6 +75,7 @@ If you find OpenAPI Generator useful for work, please consider asking your compa
|
||||
[<img src="https://openapi-generator.tech/img/companies/unified_to.jpg" width="128" height="128">](https://unified.to/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
|
||||
[<img src="https://openapi-generator.tech/img/companies/savetwt.jpg" width="128" height="128">](https://savetwt.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
|
||||
[<img src="https://openapi-generator.tech/img/companies/serpapi.png" width="128" height="128">](https://serpapi.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
|
||||
[<img src="https://openapi-generator.tech/img/companies/socialwick.png" width="128" height="128">](https://socialwick.com/?utm_source=openapi-generator&utm_medium=sponsorship&utm_campaign=oss-sponsorship)
|
||||
|
||||
#### Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS, Checkly for sponsoring the API monitoring and Gradle for sponsoring Develocity
|
||||
|
||||
@@ -90,7 +91,7 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
|
||||
| | Languages/Frameworks |
|
||||
| -------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **API clients** | **ActionScript**, **Ada**, **Apex**, **Bash**, **C**, **C#** (.net 2.0, 3.5 or later, .NET Standard 1.3 - 2.1, .NET Core 3.1, .NET 5.0. Libraries: RestSharp, GenericHost, HttpClient), **C++** (Arduino, cpp-restsdk, Qt5, Tizen, Unreal Engine 4), **Clojure**, **Crystal**, **Dart**, **Elixir**, **Elm**, **Eiffel**, **Erlang**, **Go**, **Groovy**, **Haskell** (http-client, Servant), **Java** (Apache HttpClient 4.x, Apache HttpClient 5.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client, Spring 6 RestClient, MicroProfile Rest Client, Helidon), **Jetbrains HTTP Client**, **Julia**, **k6**, **Kotlin**, **Lua**, **N4JS**, **Nim**, **Node.js/JavaScript** (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types, Apollo GraphQL DataStore), **Objective-C**, **OCaml**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (hyper, reqwest, rust-server), **Scala** (akka, http4s, scalaz, sttp, swagger-async-httpclient, pekko), **Swift** (2.x, 3.x, 4.x, 5.x, 6.x), **Typescript** (AngularJS, Angular (9.x - 19.x), Aurelia, Axios, Fetch, Inversify, jQuery, Nestjs, Node, redux-query, Rxjs), **XoJo**, **Zapier** |
|
||||
| **Server stubs** | **Ada**, **C#** (ASP.NET Core, Azure Functions), **C++** (Oat++, Pistache, Restbed, Qt5 QHTTPEngine), **Erlang**, **F#** (Giraffe), **Go** (net/http, Gin, Echo), **Haskell** (Servant, Yesod), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, Jersey, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples), [Vert.x](https://vertx.io/), [Apache Camel](https://camel.apache.org/), [Helidon](https://helidon.io/)), **Julia**, **Kotlin** (Spring Boot, [Ktor](https://github.com/ktorio/ktor), [Vert.x](https://vertx.io/)), **PHP** ([Flight](https://docs.flightphp.com/), Laravel, Lumen, [Mezzio (fka Zend Expressive)](https://github.com/mezzio/mezzio), Slim, Silex, [Symfony](https://symfony.com/)), **Python** (FastAPI, Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** ([rust-server](https://openapi-generator.tech/docs/generators/rust-server/)), **Scala** (Akka, [Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), [Play](https://www.playframework.com/), [Cask](https://github.com/com-lihaoyi/cask), Scalatra) |
|
||||
| **Server stubs** | **Ada**, **C#** (ASP.NET Core, Azure Functions), **C++** (Httplib, Oat++, Pistache, Restbed, Qt5 QHTTPEngine), **Erlang**, **F#** (Giraffe), **Go** (net/http, Gin, Echo), **Haskell** (Servant, Yesod), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, Jersey, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples), [Vert.x](https://vertx.io/), [Apache Camel](https://camel.apache.org/), [Helidon](https://helidon.io/)), **Julia**, **Kotlin** (Spring Boot, [Ktor](https://github.com/ktorio/ktor), [Vert.x](https://vertx.io/)), **PHP** ([Flight](https://docs.flightphp.com/), Laravel, Lumen, [Mezzio (fka Zend Expressive)](https://github.com/mezzio/mezzio), Slim, Silex, [Symfony](https://symfony.com/)), **Python** (FastAPI, Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** ([rust-server](https://openapi-generator.tech/docs/generators/rust-server/)), **Scala** (Akka, [Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), [Play](https://www.playframework.com/), [Cask](https://github.com/com-lihaoyi/cask), Scalatra) |
|
||||
| **API documentation generators** | **HTML**, **Confluence Wiki**, **Asciidoc**, **Markdown**, **PlantUML** |
|
||||
| **Configuration files** | [**Apache2**](https://httpd.apache.org/) |
|
||||
| **Others** | **GraphQL**, **JMeter**, **Ktorm**, **MySQL Schema**, **Postman Collection**, **Protocol Buffer**, **WSDL** |
|
||||
@@ -148,8 +149,8 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
|
||||
|
||||
| OpenAPI Generator Version | Release Date | Notes |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------- |
|
||||
| 7.20.0 (upcoming minor release) [SNAPSHOT](https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-to-test-with-the-latest-master-of-openapi-generator) | 20.02.2026 | Minor release with breaking changes (with fallback) |
|
||||
| [7.19.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v7.19.0) (latest stable release) | 20.01.2026 | Minor release with breaking changes (with fallback) |
|
||||
| 7.21.0 (upcoming minor release) [SNAPSHOT](https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-to-test-with-the-latest-master-of-openapi-generator) | 20.03.2026 | Minor release with breaking changes (with fallback) |
|
||||
| [7.20.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v7.20.0) (latest stable release) | 16.02.2026 | Minor release with breaking changes (with fallback) |
|
||||
| [6.6.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v6.6.0) | 11.05.2023 | Minor release with breaking changes (with fallback) |
|
||||
| [5.4.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.4.0) | 31.01.2022 | Minor release with breaking changes (with fallback) |
|
||||
| [4.3.1](https://github.com/OpenAPITools/openapi-generator/releases/tag/v4.3.1) | 06.05.2020 | Patch release (enhancements, bug fixes, etc) |
|
||||
@@ -212,16 +213,16 @@ See the different versions of the [openapi-generator-cli](https://search.maven.o
|
||||
<!-- RELEASE_VERSION -->
|
||||
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 11 runtime at a minimum):
|
||||
|
||||
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.19.0/openapi-generator-cli-7.19.0.jar`
|
||||
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.20.0/openapi-generator-cli-7.20.0.jar`
|
||||
|
||||
For **Mac/Linux** users:
|
||||
```sh
|
||||
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.19.0/openapi-generator-cli-7.19.0.jar -O openapi-generator-cli.jar
|
||||
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.20.0/openapi-generator-cli-7.20.0.jar -O openapi-generator-cli.jar
|
||||
```
|
||||
|
||||
For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
|
||||
```
|
||||
Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.19.0/openapi-generator-cli-7.19.0.jar
|
||||
Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.20.0/openapi-generator-cli-7.20.0.jar
|
||||
```
|
||||
|
||||
After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.
|
||||
@@ -417,12 +418,12 @@ Once built, `run-in-docker.sh` will act as an executable for openapi-generator-c
|
||||
|
||||
##### Troubleshooting
|
||||
|
||||
If an error like this occurs, just execute the **./mvnw clean install -U** command:
|
||||
If an error like this occurs, just execute the **mvn clean install -U** command:
|
||||
|
||||
> org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException
|
||||
|
||||
```sh
|
||||
./run-in-docker.sh ./mvnw clean install -U
|
||||
./run-in-docker.sh mvn clean install -U
|
||||
```
|
||||
|
||||
> Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip'
|
||||
@@ -437,7 +438,7 @@ cd openapi-generator
|
||||
vagrant up
|
||||
vagrant ssh
|
||||
cd /vagrant
|
||||
./run-in-docker.sh ./mvnw package
|
||||
./run-in-docker.sh mvn package
|
||||
```
|
||||
|
||||
### [1.7 - NPM](#table-of-contents)
|
||||
@@ -456,7 +457,7 @@ openapi-generator-cli version
|
||||
To use a specific version of "openapi-generator-cli"
|
||||
|
||||
```sh
|
||||
openapi-generator-cli version-manager set 7.19.0
|
||||
openapi-generator-cli version-manager set 7.20.0
|
||||
```
|
||||
|
||||
Or install it as dev-dependency:
|
||||
@@ -480,7 +481,7 @@ pip install openapi-generator-cli
|
||||
|
||||
To install a specific version
|
||||
```
|
||||
pip install openapi-generator-cli==7.19.0
|
||||
pip install openapi-generator-cli==7.20.0
|
||||
```
|
||||
|
||||
You can also install with [jdk4py](https://github.com/activeviam/jdk4py) instead of java binary. (python>=3.10 is required)
|
||||
@@ -506,7 +507,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
|
||||
(if you're on Windows, replace the last command with `java -jar modules\openapi-generator-cli\target\openapi-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php -o c:\temp\php_api_client`)
|
||||
|
||||
<!-- RELEASE_VERSION -->
|
||||
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.19.0/openapi-generator-cli-7.19.0.jar)
|
||||
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.20.0/openapi-generator-cli-7.20.0.jar)
|
||||
<!-- /RELEASE_VERSION -->
|
||||
|
||||
To get a list of **general** options available, please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate`
|
||||
@@ -1024,6 +1025,7 @@ Here is a list of template creators:
|
||||
* Apex: @asnelling
|
||||
* Bash: @bkryza
|
||||
* C: @PowerOfCreation @zhemant [:heart:](https://www.patreon.com/zhemant)
|
||||
* C++ Httplib: @rajvesh
|
||||
* C++ Oat++: @Kraust
|
||||
* C++ REST: @Danielku15
|
||||
* C++ Tiny: @AndersSpringborg @kaareHH @michelealbano @mkakbas
|
||||
@@ -1107,6 +1109,7 @@ Here is a list of template creators:
|
||||
* Swift 5: @4brunu
|
||||
* Swift 6: @4brunu
|
||||
* Swift Combine: @dydus0x14
|
||||
* Terraform: @jasondamour
|
||||
* TypeScript (Angular1): @mhardorf
|
||||
* TypeScript (Angular2): @roni-frantchi
|
||||
* TypeScript (Angular6): @akehir
|
||||
@@ -1129,6 +1132,7 @@ Here is a list of template creators:
|
||||
* C# Azure functions: @Abrhm7786
|
||||
* C# NancyFX: @mstefaniuk
|
||||
* C++ (Qt5 QHttpEngine): @etherealjoy
|
||||
* C++ Httplib: @rajvesh
|
||||
* C++ Oat++: @Kraust
|
||||
* C++ Pistache: @sebymiano
|
||||
* C++ Restbed: @stkrwork
|
||||
@@ -1260,7 +1264,7 @@ If you want to join the committee, please kindly apply by sending an email to te
|
||||
| JMeter | @kannkyo (2021/01) |
|
||||
| Jetbrains HTTP Client | @jlengrand (2023/01) |
|
||||
| Julia | @tanmaykm (2023/01) |
|
||||
| Kotlin | @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) |
|
||||
| Kotlin | @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) @dennisameling (2026/02) |
|
||||
| Lua | @daurnimator (2017/08) |
|
||||
| N4JS | @mmews-n4 (2023/03) |
|
||||
| Nim | |
|
||||
@@ -1276,7 +1280,7 @@ If you want to join the committee, please kindly apply by sending an email to te
|
||||
| Rust | @frol (2017/07) @farcaller (2017/08) @richardwhiuk (2019/07) @paladinzh (2020/05) @jacob-pro (2022/10) @dsteeley (2025/07) |
|
||||
| Scala | @clasnake (2017/07), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) @fish86 (2023/06) |
|
||||
| Swift | @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11) @dydus0x14 (2023/06) |
|
||||
| TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10) |
|
||||
| TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10) @dennisameling (2026/02) |
|
||||
| Xojo | @Topheee (2023/04) |
|
||||
|
||||
|
||||
|
||||
8
bin/configs/cpp-httplib-server-feature-test.yaml
Normal file
8
bin/configs/cpp-httplib-server-feature-test.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
generatorName: cpp-httplib-server
|
||||
outputDir: samples/server/petstore/cpp-httplib-server/feature-test
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/cpp-httplib-server/feature-test.json
|
||||
templateDir: modules/openapi-generator/src/main/resources/cpp-httplib-server
|
||||
additionalProperties:
|
||||
apiNamespace: "api"
|
||||
modelNamespace: "models"
|
||||
projectName: "cpp-httplib-server-feature-test"
|
||||
8
bin/configs/cpp-httplib-server-petstore.yaml
Normal file
8
bin/configs/cpp-httplib-server-petstore.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
generatorName: cpp-httplib-server
|
||||
outputDir: samples/server/petstore/cpp-httplib-server/petstore
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/cpp-httplib-server/petstore.json
|
||||
templateDir: modules/openapi-generator/src/main/resources/cpp-httplib-server
|
||||
additionalProperties:
|
||||
apiNamespace: "api"
|
||||
modelNamespace: "models"
|
||||
projectName: "cpp-httplib-server-petstore"
|
||||
@@ -1,6 +1,7 @@
|
||||
generatorName: groovy
|
||||
outputDir: samples/client/petstore/groovy
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/groovy/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/Groovy
|
||||
additionalProperties:
|
||||
enumPropertyNaming: "original"
|
||||
hideGenerationTimestamp: "true"
|
||||
|
||||
@@ -3,13 +3,11 @@ outputDir: samples/server/petstore/java-camel
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/java-camel-server
|
||||
additionalProperties:
|
||||
oas3: "true"
|
||||
hideGenerationTimestamp: true
|
||||
camelRestBindingMode: "auto"
|
||||
performBeanValidation: true
|
||||
#dateLibrary: "java8-localdatetime"
|
||||
camelDataformatProperties: "json.out.disableFeatures=WRITE_DATES_AS_TIMESTAMPS"
|
||||
library: "spring-boot"
|
||||
withXml: true
|
||||
jackson: true
|
||||
camelUseDefaultValidationErrorProcessor: true
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
generatorName: kotlin-server
|
||||
outputDir: samples/server/others/kotlin-server/polymorphism-allof-and-discriminator
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_1/polymorphism-allof-and-discriminator.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/kotlin-server
|
||||
additionalProperties:
|
||||
artifactId: kotlin-server-polymorphism-allof-and-discriminator
|
||||
library: javalin6
|
||||
@@ -0,0 +1,10 @@
|
||||
generatorName: kotlin-server
|
||||
outputDir: samples/server/others/kotlin-server/polymorphism-and-discriminator-disabled-jackson-fix
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_1/polymorphism-and-discriminator.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/kotlin-server
|
||||
additionalProperties:
|
||||
artifactId: kotlin-server-polymorphism-and-discriminator-disabled-jackson-fix
|
||||
library: javalin6
|
||||
# This is set to "true" by default, but we also want to test the case where it's set to false.
|
||||
# See KotlinServerCodegen.java for more details about this property.
|
||||
fixJacksonJsonTypeInfoInheritance: false
|
||||
@@ -0,0 +1,8 @@
|
||||
generatorName: kotlin-server
|
||||
outputDir: samples/server/others/kotlin-server/polymorphism-and-discriminator
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_1/polymorphism-and-discriminator.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/kotlin-server
|
||||
additionalProperties:
|
||||
artifactId: kotlin-server-polymorphism-and-discriminator
|
||||
library: javalin6
|
||||
fixJacksonJsonTypeInfoInheritance: true
|
||||
7
bin/configs/kotlin-server-polymorphism.yaml
Normal file
7
bin/configs/kotlin-server-polymorphism.yaml
Normal file
@@ -0,0 +1,7 @@
|
||||
generatorName: kotlin-server
|
||||
outputDir: samples/server/others/kotlin-server/polymorphism
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_1/polymorphism.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/kotlin-server
|
||||
additionalProperties:
|
||||
artifactId: kotlin-server-polymorphism
|
||||
library: javalin6
|
||||
@@ -13,3 +13,14 @@ additionalProperties:
|
||||
serializableModel: true
|
||||
beanValidations: true
|
||||
includeHttpRequestContext: true
|
||||
schemaImplements:
|
||||
Pet: com.some.pack.WithId
|
||||
Category: [ com.some.pack.CategoryInterface ]
|
||||
Dog: [ com.some.pack.Canine ]
|
||||
schemaImplementsFields:
|
||||
Pet: id
|
||||
Category: [ name, id ]
|
||||
Dog: [ bark, breed ]
|
||||
xKotlinImplementsSkip: [ com.some.pack.WithPhotoUrls ]
|
||||
xKotlinImplementsFieldsSkip:
|
||||
Pet: [ photoUrls ]
|
||||
@@ -13,3 +13,4 @@ additionalProperties:
|
||||
reactive: false
|
||||
useResponseEntity: true
|
||||
useFlowForArrayReturnType: false
|
||||
requestMappingMode: "api_interface"
|
||||
|
||||
17
bin/configs/spring-boot-4.yaml
Normal file
17
bin/configs/spring-boot-4.yaml
Normal file
@@ -0,0 +1,17 @@
|
||||
generatorName: spring
|
||||
outputDir: samples/openapi3/server/petstore/springboot-4
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/JavaSpring
|
||||
additionalProperties:
|
||||
groupId: org.openapitools.openapi3
|
||||
documentationProvider: springdoc
|
||||
artifactId: springboot
|
||||
snapshotVersion: "true"
|
||||
useSpringBoot4: true
|
||||
useJackson3: true
|
||||
useBeanValidation: true
|
||||
withXml: true
|
||||
hideGenerationTimestamp: "true"
|
||||
generateConstructorWithAllArgs: true
|
||||
generateBuilders: true
|
||||
openApiNullable: false
|
||||
15
bin/configs/spring-boot-x-implements-skip.yaml
Normal file
15
bin/configs/spring-boot-x-implements-skip.yaml
Normal file
@@ -0,0 +1,15 @@
|
||||
generatorName: spring
|
||||
outputDir: samples/server/petstore/springboot-x-implements-skip
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing-x-implements.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/JavaSpring
|
||||
additionalProperties:
|
||||
documentationProvider: springfox
|
||||
artifactId: springboot
|
||||
snapshotVersion: "true"
|
||||
hideGenerationTimestamp: "true"
|
||||
camelCaseDollarSign: "true"
|
||||
modelNameSuffix: 'Dto'
|
||||
xImplementsSkip: [ com.custompackage.InterfaceToSkip ]
|
||||
schemaImplements:
|
||||
Foo: [ com.custompackage.WithBar, com.custompackage.WithDefaultMethod ]
|
||||
Animal: com.custompackage.WithColor
|
||||
18
bin/configs/spring-cloud-4-with-optional.yaml
Normal file
18
bin/configs/spring-cloud-4-with-optional.yaml
Normal file
@@ -0,0 +1,18 @@
|
||||
generatorName: spring
|
||||
library: spring-cloud
|
||||
outputDir: samples/openapi3/client/petstore/spring-cloud-4-with-optional
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/JavaSpring
|
||||
additionalProperties:
|
||||
groupId: org.openapitools.openapi3
|
||||
documentationProvider: springdoc
|
||||
artifactId: spring-cloud-oas4
|
||||
useSpringBoot4: "true"
|
||||
useJackson3: true
|
||||
openApiNullable: false
|
||||
dateLibrary: "java8"
|
||||
useOptional: "true"
|
||||
useSwaggerUI: "false"
|
||||
hideGenerationTimestamp: "true"
|
||||
documentationProvider: none
|
||||
#optionalAcceptNullable: "false" # default to true
|
||||
21
bin/configs/spring-http-interface-springboot-4.yaml
Normal file
21
bin/configs/spring-http-interface-springboot-4.yaml
Normal file
@@ -0,0 +1,21 @@
|
||||
generatorName: spring
|
||||
library: spring-http-interface
|
||||
outputDir: samples/client/petstore/spring-http-interface-springboot-4
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/JavaSpring
|
||||
additionalProperties:
|
||||
artifactId: spring-http-interface
|
||||
snapshotVersion: "true"
|
||||
hideGenerationTimestamp: "true"
|
||||
modelNameSuffix: 'Dto'
|
||||
generatedConstructorWithRequiredArgs: "false"
|
||||
# documentation provider should be ignored
|
||||
documentationProvider: "springdoc"
|
||||
# annotation provider should be ignored
|
||||
annotationLibrary: "swagger2"
|
||||
# validation should be ignored
|
||||
useBeanValidation: "true"
|
||||
performBeanValidation: "true"
|
||||
useSpringBoot4: "true"
|
||||
useJackson3: true
|
||||
openApiNullable: false
|
||||
11
bin/configs/terraform-provider-allof-discriminator.yaml
Normal file
11
bin/configs/terraform-provider-allof-discriminator.yaml
Normal file
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/others/terraform/allof-discriminator
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/go/allof_multiple_ref_and_discriminator.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-allof
|
||||
additionalProperties:
|
||||
providerName: "allof"
|
||||
providerAddress: "registry.terraform.io/example/allof"
|
||||
hideGenerationTimestamp: "true"
|
||||
11
bin/configs/terraform-provider-oneof-anyof-required.yaml
Normal file
11
bin/configs/terraform-provider-oneof-anyof-required.yaml
Normal file
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/others/terraform/oneof-anyof-required
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/go/spec-with-oneof-anyof-required.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-oneof-anyof
|
||||
additionalProperties:
|
||||
providerName: "oneof"
|
||||
providerAddress: "registry.terraform.io/example/oneof-anyof"
|
||||
hideGenerationTimestamp: "true"
|
||||
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/others/terraform/oneof-discriminator-lookup
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/go/spec-with-oneof-discriminator.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-oneof-disc
|
||||
additionalProperties:
|
||||
providerName: "oneof"
|
||||
providerAddress: "registry.terraform.io/example/oneof-disc"
|
||||
hideGenerationTimestamp: "true"
|
||||
11
bin/configs/terraform-provider-petstore-addpet.yaml
Normal file
11
bin/configs/terraform-provider-petstore-addpet.yaml
Normal file
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/petstore/terraform-addpet
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-addpet-only.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-petstore-addpet
|
||||
additionalProperties:
|
||||
providerName: "petstore"
|
||||
providerAddress: "registry.terraform.io/example/petstore-addpet"
|
||||
hideGenerationTimestamp: "true"
|
||||
11
bin/configs/terraform-provider-petstore-new.yaml
Normal file
11
bin/configs/terraform-provider-petstore-new.yaml
Normal file
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/petstore/terraform
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-petstore
|
||||
additionalProperties:
|
||||
providerName: "petstore"
|
||||
providerAddress: "registry.terraform.io/example/petstore"
|
||||
hideGenerationTimestamp: "true"
|
||||
11
bin/configs/terraform-provider-petstore-server.yaml
Normal file
11
bin/configs/terraform-provider-petstore-server.yaml
Normal file
@@ -0,0 +1,11 @@
|
||||
generatorName: terraform-provider
|
||||
outputDir: samples/client/petstore/terraform-server
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/go-server/petstore.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/terraform-provider
|
||||
gitHost: github.com
|
||||
gitUserId: example
|
||||
gitRepoId: terraform-provider-petstore-server
|
||||
additionalProperties:
|
||||
providerName: "petstore"
|
||||
providerAddress: "registry.terraform.io/example/petstore-server"
|
||||
hideGenerationTimestamp: "true"
|
||||
@@ -10,7 +10,7 @@
|
||||
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/ClientTest.java"
|
||||
sha256: 325fdd5d7e2c97790c0fb44f712ab7b2ba022d7e1a5b0056f47b07f342682b6d
|
||||
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/JSONTest.java"
|
||||
sha256: 67941355a0a27ed9ff9318b1caa103e78b81b9aff61b594b18be5cd2bb9f6591
|
||||
sha256: b1b1d31e0df17f0b68cf2747a4a53879f12acb1bf2860e45385c679c1efe9894
|
||||
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/api/PetApiTest.java"
|
||||
sha256: 8b1b8f2a2ad00ccb090873a94a5f73e328b98317d2ec715f53bd7a1accb2a023
|
||||
- filename: "samples/client/petstore/java/okhttp-gson/src/test/java/org/openapitools/client/model/PetTest.java"
|
||||
|
||||
@@ -70,6 +70,7 @@ The following generators are available:
|
||||
* [swift-combine](generators/swift-combine.md)
|
||||
* [swift5 (deprecated)](generators/swift5.md)
|
||||
* [swift6](generators/swift6.md)
|
||||
* [terraform-provider (experimental)](generators/terraform-provider.md)
|
||||
* [typescript (experimental)](generators/typescript.md)
|
||||
* [typescript-angular](generators/typescript-angular.md)
|
||||
* [typescript-aurelia](generators/typescript-aurelia.md)
|
||||
@@ -89,6 +90,7 @@ The following generators are available:
|
||||
* [ada-server](generators/ada-server.md)
|
||||
* [aspnet-fastendpoints](generators/aspnet-fastendpoints.md)
|
||||
* [aspnetcore](generators/aspnetcore.md)
|
||||
* [cpp-httplib-server](generators/cpp-httplib-server.md)
|
||||
* [cpp-oatpp-server](generators/cpp-oatpp-server.md)
|
||||
* [cpp-pistache-server](generators/cpp-pistache-server.md)
|
||||
* [cpp-qt-qhttpengine-server](generators/cpp-qt-qhttpengine-server.md)
|
||||
|
||||
@@ -65,6 +65,7 @@ The following generators are available:
|
||||
## SERVER generators
|
||||
* [ada-server](ada-server.md)
|
||||
* [aspnetcore](aspnetcore.md)
|
||||
* [cpp-httplib-server](cpp-httplib-server.md)
|
||||
* [cpp-oatpp-server](cpp-oatpp-server.md)
|
||||
* [cpp-pistache-server](cpp-pistache-server.md)
|
||||
* [cpp-qt5-qhttpengine-server](cpp-qt5-qhttpengine-server.md)
|
||||
|
||||
286
docs/generators/cpp-httplib-server.md
Normal file
286
docs/generators/cpp-httplib-server.md
Normal file
@@ -0,0 +1,286 @@
|
||||
---
|
||||
title: Documentation for the cpp-httplib-server Generator
|
||||
---
|
||||
|
||||
## METADATA
|
||||
|
||||
| Property | Value | Notes |
|
||||
| -------- | ----- | ----- |
|
||||
| generator name | cpp-httplib-server | pass this to the generate command after -g |
|
||||
| generator stability | STABLE | |
|
||||
| generator type | SERVER | |
|
||||
| generator language | C++ | |
|
||||
| generator default templating engine | mustache | |
|
||||
| helpTxt | Generates a C++ server using the httplib library. | |
|
||||
|
||||
## CONFIG OPTIONS
|
||||
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|addApiImplStubs|Generate API implementation stubs and a sample main.cpp for quick start| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
|
||||
|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|reservedWordPrefix|Prefix to prepend to reserved words in order to avoid conflicts| |r_|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|variableNameFirstCharacterUppercase|Make first character of variable name uppercase (eg. value -> Value)| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
| Type/Alias | Instantiated By |
|
||||
| ---------- | --------------- |
|
||||
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<ul class="column-ul">
|
||||
<li>bool</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>size_t</li>
|
||||
<li>std::any</li>
|
||||
<li>std::deque</li>
|
||||
<li>std::list</li>
|
||||
<li>std::map</li>
|
||||
<li>std::optional</li>
|
||||
<li>std::pair</li>
|
||||
<li>std::queue</li>
|
||||
<li>std::set</li>
|
||||
<li>std::stack</li>
|
||||
<li>std::string</li>
|
||||
<li>std::tuple</li>
|
||||
<li>std::unordered_map</li>
|
||||
<li>std::unordered_set</li>
|
||||
<li>std::variant</li>
|
||||
<li>std::vector</li>
|
||||
<li>unsigned char</li>
|
||||
<li>unsigned int</li>
|
||||
<li>unsigned long</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<ul class="column-ul">
|
||||
<li>NULL</li>
|
||||
<li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
## FEATURE SET
|
||||
|
||||
|
||||
### Client Modification Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|BasePath|✗|ToolingExtension
|
||||
|Authorizations|✗|ToolingExtension
|
||||
|UserAgent|✗|ToolingExtension
|
||||
|MockServer|✗|ToolingExtension
|
||||
|
||||
### Data Type Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Custom|✗|OAS2,OAS3
|
||||
|Int32|✓|OAS2,OAS3
|
||||
|Int64|✓|OAS2,OAS3
|
||||
|Float|✓|OAS2,OAS3
|
||||
|Double|✓|OAS2,OAS3
|
||||
|Decimal|✓|ToolingExtension
|
||||
|String|✓|OAS2,OAS3
|
||||
|Byte|✓|OAS2,OAS3
|
||||
|Binary|✓|OAS2,OAS3
|
||||
|Boolean|✓|OAS2,OAS3
|
||||
|Date|✓|OAS2,OAS3
|
||||
|DateTime|✓|OAS2,OAS3
|
||||
|Password|✓|OAS2,OAS3
|
||||
|File|✓|OAS2
|
||||
|Uuid|✗|
|
||||
|Array|✓|OAS2,OAS3
|
||||
|Null|✗|OAS3
|
||||
|AnyType|✗|OAS2,OAS3
|
||||
|Object|✓|OAS2,OAS3
|
||||
|Maps|✓|ToolingExtension
|
||||
|CollectionFormat|✓|OAS2
|
||||
|CollectionFormatMulti|✓|OAS2
|
||||
|Enum|✓|OAS2,OAS3
|
||||
|ArrayOfEnum|✓|ToolingExtension
|
||||
|ArrayOfModel|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfModel|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfEnum|✓|ToolingExtension
|
||||
|MapOfEnum|✓|ToolingExtension
|
||||
|MapOfModel|✓|ToolingExtension
|
||||
|MapOfCollectionOfPrimitives|✓|ToolingExtension
|
||||
|MapOfCollectionOfModel|✓|ToolingExtension
|
||||
|MapOfCollectionOfEnum|✓|ToolingExtension
|
||||
|
||||
### Documentation Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Readme|✓|ToolingExtension
|
||||
|Model|✓|ToolingExtension
|
||||
|Api|✓|ToolingExtension
|
||||
|
||||
### Global Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Host|✓|OAS2,OAS3
|
||||
|BasePath|✓|OAS2,OAS3
|
||||
|Info|✓|OAS2,OAS3
|
||||
|Schemes|✗|OAS2,OAS3
|
||||
|PartialSchemes|✓|OAS2,OAS3
|
||||
|Consumes|✓|OAS2
|
||||
|Produces|✓|OAS2
|
||||
|ExternalDocumentation|✓|OAS2,OAS3
|
||||
|Examples|✓|OAS2,OAS3
|
||||
|XMLStructureDefinitions|✗|OAS2,OAS3
|
||||
|MultiServer|✗|OAS3
|
||||
|ParameterizedServer|✗|OAS3
|
||||
|ParameterStyling|✗|OAS3
|
||||
|Callbacks|✗|OAS3
|
||||
|LinkObjects|✗|OAS3
|
||||
|
||||
### Parameter Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Path|✓|OAS2,OAS3
|
||||
|Query|✓|OAS2,OAS3
|
||||
|Header|✓|OAS2,OAS3
|
||||
|Body|✓|OAS2
|
||||
|FormUnencoded|✓|OAS2
|
||||
|FormMultipart|✓|OAS2
|
||||
|Cookie|✓|OAS3
|
||||
|
||||
### Schema Support Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Simple|✓|OAS2,OAS3
|
||||
|Composite|✓|OAS2,OAS3
|
||||
|Polymorphism|✓|OAS2,OAS3
|
||||
|Union|✗|OAS3
|
||||
|allOf|✗|OAS2,OAS3
|
||||
|anyOf|✗|OAS3
|
||||
|oneOf|✗|OAS3
|
||||
|not|✗|OAS3
|
||||
|
||||
### Security Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|BasicAuth|✓|OAS2,OAS3
|
||||
|ApiKey|✓|OAS2,OAS3
|
||||
|OpenIDConnect|✗|OAS3
|
||||
|BearerToken|✓|OAS3
|
||||
|OAuth2_Implicit|✗|OAS2,OAS3
|
||||
|OAuth2_Password|✗|OAS2,OAS3
|
||||
|OAuth2_ClientCredentials|✗|OAS2,OAS3
|
||||
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
|
||||
|SignatureAuth|✗|OAS3
|
||||
|AWSV4Signature|✗|ToolingExtension
|
||||
|
||||
### Wire Format Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|JSON|✓|OAS2,OAS3
|
||||
|XML|✗|OAS2,OAS3
|
||||
|PROTOBUF|✗|ToolingExtension
|
||||
|Custom|✗|OAS2,OAS3
|
||||
@@ -87,6 +87,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|resourceFolder|resource folder for generated resources| |src/main/resources|
|
||||
|responseWrapper|wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)| |null|
|
||||
|returnSuccessCode|Generated server returns 2xx code| |false|
|
||||
|schemaImplements|Ability to supply interfaces per schema that should be implemented (serves similar purpose as vendor extension `x-implements`, but is fully decoupled from the api spec). Example: yaml `schemaImplements: {Pet: com.some.pack.WithId, Category: [com.some.pack.CategoryInterface], Dog: [com.some.pack.Canine, com.some.pack.OtherInterface]}` implements interfaces in schemas `Pet` (interface `com.some.pack.WithId`), `Category` (interface `com.some.pack.CategoryInterface`), `Dog`(interfaces `com.some.pack.Canine`, `com.some.pack.OtherInterface`)| |empty map|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
@@ -106,18 +107,21 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
|
||||
|useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
|
||||
|useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
|
||||
|useJackson3|Set it in order to use jackson 3 dependencies (only allowed when `useSpringBoot4` is set and incompatible with `openApiNullable`).| |false|
|
||||
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
|
||||
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
|
||||
|useOptional|Use Optional container for optional parameters| |false|
|
||||
|useResponseEntity|Use the `ResponseEntity` type to wrap return values of generated API methods. If disabled, method are annotated using a `@ResponseStatus` annotation, which has the status of the first response declared in the Api definition| |true|
|
||||
|useSealed|Whether to generate sealed model interfaces and classes| |false|
|
||||
|useSpringBoot3|Generate code and provide dependencies for use with Spring Boot ≥ 3 (use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
|
||||
|useSpringBoot4|Generate code and provide dependencies for use with Spring Boot 4.x. (Use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
|
||||
|useSpringBuiltInValidation|Disable `@Validated` at the class level when using built-in validation.| |false|
|
||||
|useSpringController|Annotate the generated API as a Spring Controller| |false|
|
||||
|useSwaggerUI|Open the OpenApi specification in swagger-ui. Will also import and configure needed dependencies| |true|
|
||||
|useTags|use tags for creating interface and controller classnames| |false|
|
||||
|virtualService|Generates the virtual service. For more details refer - https://github.com/virtualansoftware/virtualan/wiki| |false|
|
||||
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
|
||||
|xImplementsSkip|Ability to choose interfaces that should NOT be implemented in the models despite their presence in vendor extension `x-implements`. Takes a list of fully qualified interface names. Example: yaml `xImplementsSkip: [com.some.pack.WithPhotoUrls]` skips implementing the interface `com.some.pack.WithPhotoUrls` in any schema| |empty list|
|
||||
|
||||
## SUPPORTED VENDOR EXTENSIONS
|
||||
|
||||
|
||||
@@ -30,6 +30,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|featureHSTS|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |true|
|
||||
|featureMetrics|Enables metrics feature.| |true|
|
||||
|featureResources|Generates routes in a typed way, for both: constructing URLs and reading the parameters.| |true|
|
||||
|fixJacksonJsonTypeInfoInheritance|When true (default), ensures Jackson polymorphism works correctly by: (1) always setting visible=true on @JsonTypeInfo, and (2) adding the discriminator property to child models with appropriate default values. When false, visible is only set to true if all children already define the discriminator property.| |true|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files. This option is currently supported only when using jaxrs-spec library.| |false|
|
||||
|library|library template (sub-template)|<dl><dt>**ktor**</dt><dd>ktor framework</dd><dt>**ktor2**</dt><dd>ktor (2.x) framework</dd><dt>**jaxrs-spec**</dt><dd>JAX-RS spec only</dd><dt>**javalin5**</dt><dd>Javalin 5</dd><dt>**javalin6**</dt><dd>Javalin 6</dd></dl>|ktor|
|
||||
@@ -262,11 +263,11 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
| ---- | --------- | ---------- |
|
||||
|Simple|✓|OAS2,OAS3
|
||||
|Composite|✓|OAS2,OAS3
|
||||
|Polymorphism|✗|OAS2,OAS3
|
||||
|Polymorphism|✓|OAS2,OAS3
|
||||
|Union|✗|OAS3
|
||||
|allOf|✗|OAS2,OAS3
|
||||
|allOf|✓|OAS2,OAS3
|
||||
|anyOf|✗|OAS3
|
||||
|oneOf|✗|OAS3
|
||||
|oneOf|✓|OAS3
|
||||
|not|✗|OAS3
|
||||
|
||||
### Security Feature
|
||||
|
||||
@@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|apiSuffix|suffix for api classes| |Api|
|
||||
|artifactId|Generated artifact id (name of jar).| |openapi-spring|
|
||||
|artifactVersion|Generated artifact's package version.| |1.0.0|
|
||||
|autoXSpringPaginated|Automatically add x-spring-paginated to operations that have 'page', 'size', and 'sort' query parameters. When enabled, operations with all three parameters will have Pageable support automatically applied. Operations with x-spring-paginated explicitly set to false will not be auto-detected.| |false|
|
||||
|basePackage|base package (invokerPackage) for generated code| |org.openapitools|
|
||||
|beanQualifiers|Whether to add fully-qualifier class names as bean qualifiers in @Component and @RestController annotations. May be used to prevent bean names clash if multiple generated libraries (contexts) added to single project.| |false|
|
||||
|configPackage|configuration package for generated code| |org.openapitools.configuration|
|
||||
@@ -43,6 +44,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|reactive|use coroutines for reactive behavior| |false|
|
||||
|requestMappingMode|Where to generate the class level @RequestMapping annotation.|<dl><dt>**api_interface**</dt><dd>Generate the @RequestMapping annotation on the generated Api Interface.</dd><dt>**controller**</dt><dd>Generate the @RequestMapping annotation on the generated Api Controller Implementation.</dd><dt>**none**</dt><dd>Do not add a class level @RequestMapping annotation.</dd></dl>|controller|
|
||||
|schemaImplements|A map of single interface or a list of interfaces per schema name that should be implemented (serves similar purpose as `x-kotlin-implements`, but is fully decoupled from the api spec). Example: yaml `schemaImplements: {Pet: com.some.pack.WithId, Category: [com.some.pack.CategoryInterface], Dog: [com.some.pack.Canine, com.some.pack.OtherInterface]}` implements interfaces in schemas `Pet` (interface `com.some.pack.WithId`), `Category` (interface `com.some.pack.CategoryInterface`), `Dog`(interfaces `com.some.pack.Canine`, `com.some.pack.OtherInterface`)| |empty map|
|
||||
|schemaImplementsFields|A map of single field or a list of fields per schema name that should be prepended with `override` (serves similar purpose as `x-kotlin-implements-fields`, but is fully decoupled from the api spec). Example: yaml `schemaImplementsFields: {Pet: id, Category: [name, id], Dog: [bark, breed]}` marks fields to be prepended with `override` in schemas `Pet` (field `id`), `Category` (fields `name`, `id`) and `Dog` (fields `bark`, `breed`)| |empty map|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|serverPort|configuration the port in which the sever is to run on| |8080|
|
||||
|serviceImplementation|generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated| |false|
|
||||
@@ -59,6 +62,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|useSpringBoot3|Generate code and provide dependencies for use with Spring Boot ≥ 3 (use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
|
||||
|useSwaggerUI|Open the OpenApi specification in swagger-ui. Will also import and configure needed dependencies| |true|
|
||||
|useTags|Whether to use tags for creating interface and controller class names| |false|
|
||||
|xKotlinImplementsFieldsSkip|A list of fields per schema name that should NOT be created with `override` keyword despite their presence in vendor extension `x-kotlin-implements-fields` for the schema. Example: yaml `xKotlinImplementsFieldsSkip: Pet: [photoUrls]` skips `override` for `photoUrls` in schema `Pet`| |empty map|
|
||||
|xKotlinImplementsSkip|A list of fully qualified interfaces that should NOT be implemented despite their presence in vendor extension `x-kotlin-implements`. Example: yaml `xKotlinImplementsSkip: [com.some.pack.WithPhotoUrls]` skips implementing the interface in any schema| |empty list|
|
||||
|
||||
## SUPPORTED VENDOR EXTENSIONS
|
||||
|
||||
@@ -69,12 +74,14 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|x-content-type|Specify custom value for 'Content-Type' header for operation|OPERATION|null
|
||||
|x-discriminator-value|Used with model inheritance to specify value for discriminator that identifies current model|MODEL|
|
||||
|x-field-extra-annotation|List of custom annotations to be added to property|FIELD, OPERATION_PARAMETER|null
|
||||
|x-operation-extra-annotation|List of custom annotations to be added to operation|OPERATION|null
|
||||
|x-pattern-message|Add this property whenever you need to customize the invalidation error message for the regex pattern of a variable|FIELD, OPERATION_PARAMETER|null
|
||||
|x-size-message|Add this property whenever you need to customize the invalidation error message for the size or length of a variable|FIELD, OPERATION_PARAMETER|null
|
||||
|x-minimum-message|Add this property whenever you need to customize the invalidation error message for the minimum value of a variable|FIELD, OPERATION_PARAMETER|null
|
||||
|x-maximum-message|Add this property whenever you need to customize the invalidation error message for the maximum value of a variable|FIELD, OPERATION_PARAMETER|null
|
||||
|x-kotlin-implements|Ability to specify interfaces that model must implement|MODEL|empty array
|
||||
|x-kotlin-implements-fields|Specify attributes that are implemented by the interface(s) added via `x-kotlin-implements`|MODEL|empty array
|
||||
|x-spring-paginated|Add `org.springframework.data.domain.Pageable` to controller method. Can be used to handle `page`, `size` and `sort` query parameters. If these query parameters are also specified in the operation spec, they will be removed from the controller method as their values can be obtained from the `Pageable` object.|OPERATION|false
|
||||
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@@ -80,6 +80,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|resourceFolder|resource folder for generated resources| |src/main/resources|
|
||||
|responseWrapper|wrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, RxObservable, RxSingle or fully qualified type)| |null|
|
||||
|returnSuccessCode|Generated server returns 2xx code| |false|
|
||||
|schemaImplements|Ability to supply interfaces per schema that should be implemented (serves similar purpose as vendor extension `x-implements`, but is fully decoupled from the api spec). Example: yaml `schemaImplements: {Pet: com.some.pack.WithId, Category: [com.some.pack.CategoryInterface], Dog: [com.some.pack.Canine, com.some.pack.OtherInterface]}` implements interfaces in schemas `Pet` (interface `com.some.pack.WithId`), `Category` (interface `com.some.pack.CategoryInterface`), `Dog`(interfaces `com.some.pack.Canine`, `com.some.pack.OtherInterface`)| |empty map|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
@@ -99,18 +100,21 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|useEnumCaseInsensitive|Use `equalsIgnoreCase` when String for enum comparison| |false|
|
||||
|useFeignClientContextId|Whether to generate Feign client with contextId parameter.| |true|
|
||||
|useFeignClientUrl|Whether to generate Feign client with url parameter.| |true|
|
||||
|useJackson3|Set it in order to use jackson 3 dependencies (only allowed when `useSpringBoot4` is set and incompatible with `openApiNullable`).| |false|
|
||||
|useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
|
||||
|useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
|
||||
|useOptional|Use Optional container for optional parameters| |false|
|
||||
|useResponseEntity|Use the `ResponseEntity` type to wrap return values of generated API methods. If disabled, method are annotated using a `@ResponseStatus` annotation, which has the status of the first response declared in the Api definition| |true|
|
||||
|useSealed|Whether to generate sealed model interfaces and classes| |false|
|
||||
|useSpringBoot3|Generate code and provide dependencies for use with Spring Boot ≥ 3 (use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
|
||||
|useSpringBoot4|Generate code and provide dependencies for use with Spring Boot 4.x. (Use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.| |false|
|
||||
|useSpringBuiltInValidation|Disable `@Validated` at the class level when using built-in validation.| |false|
|
||||
|useSpringController|Annotate the generated API as a Spring Controller| |false|
|
||||
|useSwaggerUI|Open the OpenApi specification in swagger-ui. Will also import and configure needed dependencies| |true|
|
||||
|useTags|use tags for creating interface and controller classnames| |false|
|
||||
|virtualService|Generates the virtual service. For more details refer - https://github.com/virtualansoftware/virtualan/wiki| |false|
|
||||
|withXml|whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)| |false|
|
||||
|xImplementsSkip|Ability to choose interfaces that should NOT be implemented in the models despite their presence in vendor extension `x-implements`. Takes a list of fully qualified interface names. Example: yaml `xImplementsSkip: [com.some.pack.WithPhotoUrls]` skips implementing the interface `com.some.pack.WithPhotoUrls` in any schema| |empty list|
|
||||
|
||||
## SUPPORTED VENDOR EXTENSIONS
|
||||
|
||||
|
||||
229
docs/generators/terraform-provider.md
Normal file
229
docs/generators/terraform-provider.md
Normal file
@@ -0,0 +1,229 @@
|
||||
---
|
||||
title: Documentation for the terraform-provider Generator
|
||||
---
|
||||
|
||||
## METADATA
|
||||
|
||||
| Property | Value | Notes |
|
||||
| -------- | ----- | ----- |
|
||||
| generator name | terraform-provider | pass this to the generate command after -g |
|
||||
| generator stability | EXPERIMENTAL | |
|
||||
| generator type | CLIENT | |
|
||||
| generator language | Go | |
|
||||
| generator default templating engine | mustache | |
|
||||
| helpTxt | Generates a Terraform provider (Go, using HashiCorp Plugin Framework). | |
|
||||
|
||||
## CONFIG OPTIONS
|
||||
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|providerAddress|Terraform provider registry address| |registry.terraform.io/example/example|
|
||||
|providerName|Terraform provider name (e.g. 'petstore')| |example|
|
||||
|providerVersion|Terraform provider version| |0.1.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
| Type/Alias | Instantiated By |
|
||||
| ---------- | --------------- |
|
||||
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<ul class="column-ul">
|
||||
<li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>interface{}</li>
|
||||
<li>map[string]interface{}</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<ul class="column-ul">
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>uintptr</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
|
||||
## FEATURE SET
|
||||
|
||||
|
||||
### Client Modification Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|BasePath|✗|ToolingExtension
|
||||
|Authorizations|✗|ToolingExtension
|
||||
|UserAgent|✗|ToolingExtension
|
||||
|MockServer|✗|ToolingExtension
|
||||
|
||||
### Data Type Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Custom|✗|OAS2,OAS3
|
||||
|Int32|✓|OAS2,OAS3
|
||||
|Int64|✓|OAS2,OAS3
|
||||
|Float|✓|OAS2,OAS3
|
||||
|Double|✓|OAS2,OAS3
|
||||
|Decimal|✓|ToolingExtension
|
||||
|String|✓|OAS2,OAS3
|
||||
|Byte|✓|OAS2,OAS3
|
||||
|Binary|✓|OAS2,OAS3
|
||||
|Boolean|✓|OAS2,OAS3
|
||||
|Date|✓|OAS2,OAS3
|
||||
|DateTime|✓|OAS2,OAS3
|
||||
|Password|✓|OAS2,OAS3
|
||||
|File|✓|OAS2
|
||||
|Uuid|✗|
|
||||
|Array|✓|OAS2,OAS3
|
||||
|Null|✗|OAS3
|
||||
|AnyType|✗|OAS2,OAS3
|
||||
|Object|✓|OAS2,OAS3
|
||||
|Maps|✓|ToolingExtension
|
||||
|CollectionFormat|✓|OAS2
|
||||
|CollectionFormatMulti|✓|OAS2
|
||||
|Enum|✓|OAS2,OAS3
|
||||
|ArrayOfEnum|✓|ToolingExtension
|
||||
|ArrayOfModel|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfModel|✓|ToolingExtension
|
||||
|ArrayOfCollectionOfEnum|✓|ToolingExtension
|
||||
|MapOfEnum|✓|ToolingExtension
|
||||
|MapOfModel|✓|ToolingExtension
|
||||
|MapOfCollectionOfPrimitives|✓|ToolingExtension
|
||||
|MapOfCollectionOfModel|✓|ToolingExtension
|
||||
|MapOfCollectionOfEnum|✓|ToolingExtension
|
||||
|
||||
### Documentation Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Readme|✓|ToolingExtension
|
||||
|Model|✓|ToolingExtension
|
||||
|Api|✓|ToolingExtension
|
||||
|
||||
### Global Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Host|✓|OAS2,OAS3
|
||||
|BasePath|✓|OAS2,OAS3
|
||||
|Info|✓|OAS2,OAS3
|
||||
|Schemes|✗|OAS2,OAS3
|
||||
|PartialSchemes|✓|OAS2,OAS3
|
||||
|Consumes|✓|OAS2
|
||||
|Produces|✓|OAS2
|
||||
|ExternalDocumentation|✓|OAS2,OAS3
|
||||
|Examples|✓|OAS2,OAS3
|
||||
|XMLStructureDefinitions|✗|OAS2,OAS3
|
||||
|MultiServer|✗|OAS3
|
||||
|ParameterizedServer|✗|OAS3
|
||||
|ParameterStyling|✗|OAS3
|
||||
|Callbacks|✗|OAS3
|
||||
|LinkObjects|✗|OAS3
|
||||
|
||||
### Parameter Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Path|✓|OAS2,OAS3
|
||||
|Query|✓|OAS2,OAS3
|
||||
|Header|✓|OAS2,OAS3
|
||||
|Body|✓|OAS2
|
||||
|FormUnencoded|✓|OAS2
|
||||
|FormMultipart|✓|OAS2
|
||||
|Cookie|✓|OAS3
|
||||
|
||||
### Schema Support Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|Simple|✓|OAS2,OAS3
|
||||
|Composite|✓|OAS2,OAS3
|
||||
|Polymorphism|✗|OAS2,OAS3
|
||||
|Union|✗|OAS3
|
||||
|allOf|✗|OAS2,OAS3
|
||||
|anyOf|✗|OAS3
|
||||
|oneOf|✗|OAS3
|
||||
|not|✗|OAS3
|
||||
|
||||
### Security Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|BasicAuth|✓|OAS2,OAS3
|
||||
|ApiKey|✓|OAS2,OAS3
|
||||
|OpenIDConnect|✗|OAS3
|
||||
|BearerToken|✓|OAS3
|
||||
|OAuth2_Implicit|✗|OAS2,OAS3
|
||||
|OAuth2_Password|✗|OAS2,OAS3
|
||||
|OAuth2_ClientCredentials|✗|OAS2,OAS3
|
||||
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
|
||||
|SignatureAuth|✗|OAS3
|
||||
|AWSV4Signature|✗|ToolingExtension
|
||||
|
||||
### Wire Format Feature
|
||||
| Name | Supported | Defined By |
|
||||
| ---- | --------- | ---------- |
|
||||
|JSON|✓|OAS2,OAS3
|
||||
|XML|✗|OAS2,OAS3
|
||||
|PROTOBUF|✗|ToolingExtension
|
||||
|Custom|✗|OAS2,OAS3
|
||||
@@ -20,7 +20,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|axiosVersion|Use this property to override the axios version in package.json| |^1.6.1|
|
||||
|axiosVersion|Use this property to override the axios version in package.json| |^1.13.5|
|
||||
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
|
||||
|
||||
@@ -42,6 +42,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|supportsES6|Generate code that conforms to ES6.| |false|
|
||||
|typescriptMajorVersion|Specify the major version of TypeScript to use in the client code. Default is 5.| |5|
|
||||
|useErasableSyntax|Use erasable syntax for the generated code. This is a temporary feature and will be removed in the future.| |false|
|
||||
|useInversify|Enable this to generate decorators and service identifiers for the InversifyJS inversion of control container. If you set 'deno' as 'platform', the generator will process this value as 'disable'.| |false|
|
||||
|useObjectParameters|Use aggregate parameter objects as function arguments for api operations instead of passing each parameter as a separate function argument.| |false|
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<groupId>org.openapitools</groupId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# RELEASE_VERSION
|
||||
openApiGeneratorVersion=7.20.0-SNAPSHOT
|
||||
openApiGeneratorVersion=7.21.0-SNAPSHOT
|
||||
# /RELEASE_VERSION
|
||||
|
||||
# BEGIN placeholders
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# RELEASE_VERSION
|
||||
openApiGeneratorVersion=7.20.0-SNAPSHOT
|
||||
openApiGeneratorVersion=7.21.0-SNAPSHOT
|
||||
# /RELEASE_VERSION
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<executions>
|
||||
<execution>
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<executions>
|
||||
<execution>
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<dependencies>
|
||||
<dependency>
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<executions>
|
||||
<execution>
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<executions>
|
||||
<execution>
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<executions>
|
||||
<execution>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# RELEASE_VERSION
|
||||
openApiGeneratorVersion=7.20.0-SNAPSHOT
|
||||
openApiGeneratorVersion=7.21.0-SNAPSHOT
|
||||
# /RELEASE_VERSION
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -95,7 +95,7 @@ class MillOpenapiModuleTest extends Matchers {
|
||||
eval.apply(MillOpenapiModuleTestRoot.petstoreMicroprofile.compile)
|
||||
}
|
||||
|
||||
result shouldBe a[Right[_, _]]
|
||||
result shouldBe a[Right[?, ?]]
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -104,6 +104,6 @@ class MillOpenapiModuleTest extends Matchers {
|
||||
// execute 'compile` task
|
||||
eval.apply(MillOpenapiModuleTestRoot.petstoreInvalid.compile)
|
||||
}
|
||||
result shouldBe a[Left[_, _]]
|
||||
result shouldBe a[Left[?, ?]]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-project</artifactId>
|
||||
<!-- RELEASE_VERSION -->
|
||||
<version>7.20.0-SNAPSHOT</version>
|
||||
<version>7.21.0-SNAPSHOT</version>
|
||||
<!-- /RELEASE_VERSION -->
|
||||
<relativePath>../../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
@@ -112,6 +112,10 @@ public class CliOption {
|
||||
return new CliOption(opt, description, SchemaTypeUtil.STRING_TYPE);
|
||||
}
|
||||
|
||||
public static CliOption newString(String opt, String description, String defaultValue) {
|
||||
return new CliOption(opt, description, SchemaTypeUtil.STRING_TYPE).defaultValue(String.valueOf(defaultValue));
|
||||
}
|
||||
|
||||
@JsonIgnore
|
||||
public String getOptionHelp() {
|
||||
StringBuilder sb = new StringBuilder(description);
|
||||
|
||||
@@ -94,8 +94,11 @@ import static org.openapitools.codegen.utils.OnceLogger.once;
|
||||
import static org.openapitools.codegen.utils.StringUtils.*;
|
||||
|
||||
public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
private final Logger LOGGER = LoggerFactory.getLogger(DefaultCodegen.class);
|
||||
|
||||
public static final Pattern SPLIT_ON_SEMICOLON_OR_NEWLINE_REGEX = Pattern.compile("\\s*(;|\\r?\\n)\\s*"); // Splits on semicolon or new line, ignoring surrounding whitespace
|
||||
|
||||
public static FeatureSet DefaultFeatureSet;
|
||||
|
||||
// A cache of sanitized words. The sanitizeName() method is invoked many times with the same
|
||||
@@ -190,15 +193,20 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected Map<String, String> operationIdNameMapping = new HashMap<>();
|
||||
// a map to store the rules in OpenAPI Normalizer
|
||||
protected Map<String, String> openapiNormalizer = new HashMap<>();
|
||||
@Setter protected String modelPackage = "", apiPackage = "";
|
||||
@Setter
|
||||
protected String modelPackage = "", apiPackage = "";
|
||||
protected String fileSuffix;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected String modelNamePrefix = "", modelNameSuffix = "";
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected String apiNamePrefix = "", apiNameSuffix = "Api";
|
||||
protected String testPackage = "";
|
||||
@Setter protected String filesMetadataFilename = "FILES";
|
||||
@Setter protected String versionMetadataFilename = "VERSION";
|
||||
@Setter
|
||||
protected String filesMetadataFilename = "FILES";
|
||||
@Setter
|
||||
protected String versionMetadataFilename = "VERSION";
|
||||
/*
|
||||
apiTemplateFiles are for API outputs only (controllers/handlers).
|
||||
API templates may be written multiple times; APIs are grouped by tag and the file is written once per tag group.
|
||||
@@ -210,7 +218,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected Map<String, String> apiDocTemplateFiles = new HashMap<>();
|
||||
protected Map<String, String> modelDocTemplateFiles = new HashMap<>();
|
||||
protected Map<String, String> reservedWordsMappings = new HashMap<>();
|
||||
@Setter protected String templateDir;
|
||||
@Setter
|
||||
protected String templateDir;
|
||||
protected String embeddedTemplateDir;
|
||||
protected Map<String, Object> additionalProperties = new HashMap<>();
|
||||
protected Map<String, String> serverVariables = new HashMap<>();
|
||||
@@ -225,9 +234,11 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected List<CliOption> cliOptions = new ArrayList<>();
|
||||
protected boolean skipOverwrite;
|
||||
protected boolean removeOperationIdPrefix;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected String removeOperationIdPrefixDelimiter = "_";
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected int removeOperationIdPrefixCount = 1;
|
||||
protected boolean skipOperationExample;
|
||||
// sort operations by default
|
||||
@@ -262,13 +273,17 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected boolean supportsMixins;
|
||||
protected Map<String, String> supportedLibraries = new LinkedHashMap<>();
|
||||
protected String library;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected Boolean sortParamsByRequiredFlag = true;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected Boolean sortModelPropertiesByRequiredFlag = false;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected Boolean ensureUniqueParams = true;
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected Boolean allowUnicodeIdentifiers = false;
|
||||
protected String gitHost, gitUserId, gitRepoId, releaseNote;
|
||||
protected String httpUserAgent;
|
||||
@@ -279,7 +294,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected Map<String, String> specialCharReplacements = new LinkedHashMap<>();
|
||||
// When a model is an alias for a simple type
|
||||
protected Map<String, String> typeAliases = Collections.emptyMap();
|
||||
@Getter @Setter
|
||||
@Getter
|
||||
@Setter
|
||||
protected Boolean prependFormOrBodyParameters = false;
|
||||
// The extension of the generated documentation files (defaults to markdown .md)
|
||||
protected String docExtension;
|
||||
@@ -302,15 +318,18 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected boolean removeEnumValuePrefix = false;
|
||||
|
||||
// Support legacy logic for evaluating discriminators
|
||||
@Setter protected boolean legacyDiscriminatorBehavior = true;
|
||||
@Setter
|
||||
protected boolean legacyDiscriminatorBehavior = true;
|
||||
|
||||
// Specify what to do if the 'additionalProperties' keyword is not present in a schema.
|
||||
// See CodegenConstants.java for more details.
|
||||
@Setter protected boolean disallowAdditionalPropertiesIfNotPresent = true;
|
||||
@Setter
|
||||
protected boolean disallowAdditionalPropertiesIfNotPresent = true;
|
||||
|
||||
// If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.
|
||||
// With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
|
||||
@Setter protected boolean enumUnknownDefaultCase = false;
|
||||
@Setter
|
||||
protected boolean enumUnknownDefaultCase = false;
|
||||
protected String enumUnknownDefaultCaseName = "unknown_default_open_api";
|
||||
|
||||
// make openapi available to all methods
|
||||
@@ -333,11 +352,18 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected boolean addSuffixToDuplicateOperationNicknames = true;
|
||||
|
||||
// Whether to automatically hardcode params that are considered Constants by OpenAPI Spec
|
||||
@Setter protected boolean autosetConstants = false;
|
||||
@Setter
|
||||
protected boolean autosetConstants = false;
|
||||
|
||||
@Setter @Getter boolean arrayDefaultToEmpty, arrayNullableDefaultToEmpty, arrayOptionalNullableDefaultToEmpty, arrayOptionalDefaultToEmpty;
|
||||
@Setter @Getter boolean mapDefaultToEmpty, mapNullableDefaultToEmpty, mapOptionalNullableDefaultToEmpty, mapOptionalDefaultToEmpty;
|
||||
@Setter @Getter protected boolean defaultToEmptyContainer;
|
||||
@Setter
|
||||
@Getter
|
||||
boolean arrayDefaultToEmpty, arrayNullableDefaultToEmpty, arrayOptionalNullableDefaultToEmpty, arrayOptionalDefaultToEmpty;
|
||||
@Setter
|
||||
@Getter
|
||||
boolean mapDefaultToEmpty, mapNullableDefaultToEmpty, mapOptionalNullableDefaultToEmpty, mapOptionalDefaultToEmpty;
|
||||
@Setter
|
||||
@Getter
|
||||
protected boolean defaultToEmptyContainer;
|
||||
|
||||
final List EMPTY_LIST = new ArrayList();
|
||||
|
||||
@@ -572,7 +598,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
? false
|
||||
: model.parentModel.allVars.stream().anyMatch(p ->
|
||||
p.name.equals(property.name) &&
|
||||
(p.dataType.equals(property.dataType) == false || p.datatypeWithEnum.equals(property.datatypeWithEnum) == false));
|
||||
(p.dataType.equals(property.dataType) == false || p.datatypeWithEnum.equals(property.datatypeWithEnum) == false));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -716,7 +742,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
for (CodegenProperty cp : model.allVars) {
|
||||
// detect self import
|
||||
if (cp.dataType.equalsIgnoreCase(model.classname) ||
|
||||
(cp.isContainer && cp.items != null && cp.items.dataType.equalsIgnoreCase(model.classname))) {
|
||||
(cp.isContainer && cp.items != null && cp.items.dataType.equalsIgnoreCase(model.classname))) {
|
||||
model.imports.remove(model.classname); // remove self import
|
||||
cp.isSelfReference = true;
|
||||
}
|
||||
@@ -758,7 +784,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
private void setCircularReferencesOnProperties(final String root,
|
||||
final Map<String, List<CodegenProperty>> dependencyMap) {
|
||||
final Map<String, List<CodegenProperty>> dependencyMap) {
|
||||
dependencyMap.getOrDefault(root, new ArrayList<>())
|
||||
.forEach(prop -> {
|
||||
final List<String> unvisited =
|
||||
@@ -771,9 +797,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
private boolean isCircularReference(final String root,
|
||||
final Set<String> visited,
|
||||
final List<String> unvisited,
|
||||
final Map<String, List<CodegenProperty>> dependencyMap) {
|
||||
final Set<String> visited,
|
||||
final List<String> unvisited,
|
||||
final Map<String, List<CodegenProperty>> dependencyMap) {
|
||||
for (int i = 0; i < unvisited.size(); i++) {
|
||||
final String next = unvisited.get(i);
|
||||
if (!visited.contains(next)) {
|
||||
@@ -1162,7 +1188,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
return escapeText(input).replace("'", "\\'");
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Escape characters while allowing new lines
|
||||
*
|
||||
@@ -1206,7 +1231,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
@Override
|
||||
public String escapeUnsafeCharacters(String input) {
|
||||
LOGGER.warn("escapeUnsafeCharacters should be overridden in the code generator with proper logic to escape " +
|
||||
"unsafe characters");
|
||||
"unsafe characters");
|
||||
// doing nothing by default and code generator should implement
|
||||
// the logic to prevent code injection
|
||||
// later we'll make this method abstract to make sure
|
||||
@@ -1223,7 +1248,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
@Override
|
||||
public String escapeQuotationMark(String input) {
|
||||
LOGGER.warn("escapeQuotationMark should be overridden in the code generator with proper logic to escape " +
|
||||
"single/double quote");
|
||||
"single/double quote");
|
||||
return input.replace("\"", "\\\"");
|
||||
}
|
||||
|
||||
@@ -1801,7 +1826,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
CliOption legacyDiscriminatorBehaviorOpt = CliOption.newBoolean(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR_DESC).defaultValue(Boolean.TRUE.toString());
|
||||
Map<String, String> legacyDiscriminatorBehaviorOpts = new HashMap<>();
|
||||
legacyDiscriminatorBehaviorOpts.put("true", "The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.");
|
||||
legacyDiscriminatorBehaviorOpts.put("false", "The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.");
|
||||
legacyDiscriminatorBehaviorOpts.put("false",
|
||||
"The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.");
|
||||
legacyDiscriminatorBehaviorOpt.setEnum(legacyDiscriminatorBehaviorOpts);
|
||||
cliOptions.add(legacyDiscriminatorBehaviorOpt);
|
||||
|
||||
@@ -2285,7 +2311,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
}
|
||||
|
||||
|
||||
protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
|
||||
Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
|
||||
if (inner == null) {
|
||||
@@ -2359,7 +2384,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
return ModelUtils.unaliasSchema(this.openAPI, schema, schemaMapping);
|
||||
}
|
||||
|
||||
private List<Map<String, Object>> unaliasExamples(Map<String, Example> examples){
|
||||
private List<Map<String, Object>> unaliasExamples(Map<String, Example> examples) {
|
||||
return ExamplesUtils.unaliasExamples(this.openAPI, examples);
|
||||
}
|
||||
|
||||
@@ -2631,6 +2656,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
private static class NamedSchema {
|
||||
|
||||
private NamedSchema(String name, Schema s, boolean required, boolean schemaIsFromAdditionalProperties) {
|
||||
this.name = name;
|
||||
this.schema = s;
|
||||
@@ -2645,13 +2671,15 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o) {
|
||||
if (this == o) return true;
|
||||
if (o == null || getClass() != o.getClass()) return false;
|
||||
if (this == o)
|
||||
return true;
|
||||
if (o == null || getClass() != o.getClass())
|
||||
return false;
|
||||
NamedSchema that = (NamedSchema) o;
|
||||
return Objects.equals(required, that.required) &&
|
||||
Objects.equals(name, that.name) &&
|
||||
Objects.equals(schema, that.schema) &&
|
||||
Objects.equals(schemaIsFromAdditionalProperties, that.schemaIsFromAdditionalProperties);
|
||||
Objects.equals(name, that.name) &&
|
||||
Objects.equals(schema, that.schema) &&
|
||||
Objects.equals(schemaIsFromAdditionalProperties, that.schemaIsFromAdditionalProperties);
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -2673,7 +2701,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
if (composed.getProperties() != null && !composed.getProperties().isEmpty()) {
|
||||
if (composed.getOneOf() != null && !composed.getOneOf().isEmpty()) {
|
||||
LOGGER.warn("'oneOf' is intended to include only the additional optional OAS extension discriminator object. " +
|
||||
"For more details, see https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.2.1.3 and the OAS section on 'Composition and Inheritance'.");
|
||||
"For more details, see https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.2.1.3 and the OAS section on 'Composition and Inheritance'.");
|
||||
}
|
||||
addVars(m, unaliasPropertySchema(composed.getProperties()), composed.getRequired(), null, null);
|
||||
}
|
||||
@@ -3068,7 +3096,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
m.getVendorExtensions().putAll(schema.getExtensions());
|
||||
}
|
||||
m.isAlias = (typeAliases.containsKey(name)
|
||||
|| isAliasOfSimpleTypes(schema)); // check if the unaliased schema is an alias of simple OAS types
|
||||
|| isAliasOfSimpleTypes(schema)); // check if the unaliased schema is an alias of simple OAS types
|
||||
m.setDiscriminator(createDiscriminator(name, schema));
|
||||
|
||||
if (schema.getDeprecated() != null) {
|
||||
@@ -3439,7 +3467,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
if (discriminatorsPropNames.size() > 1) {
|
||||
once(LOGGER).warn("The oneOf schemas have conflicting discriminator property names. " +
|
||||
"oneOf schemas must have the same property name, but found " + String.join(", ", discriminatorsPropNames));
|
||||
"oneOf schemas must have the same property name, but found " + String.join(", ", discriminatorsPropNames));
|
||||
}
|
||||
if (foundDisc != null && (hasDiscriminatorCnt + hasNullTypeCnt) == composedSchema.getOneOf().size() && discriminatorsPropNames.size() == 1) {
|
||||
disc.setPropertyName(foundDisc.getPropertyName());
|
||||
@@ -3468,7 +3496,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
if (discriminatorsPropNames.size() > 1) {
|
||||
once(LOGGER).warn("The anyOf schemas have conflicting discriminator property names. " +
|
||||
"anyOf schemas must have the same property name, but found " + String.join(", ", discriminatorsPropNames));
|
||||
"anyOf schemas must have the same property name, but found " + String.join(", ", discriminatorsPropNames));
|
||||
}
|
||||
if (foundDisc != null && (hasDiscriminatorCnt + hasNullTypeCnt) == composedSchema.getAnyOf().size() && discriminatorsPropNames.size() == 1) {
|
||||
disc.setPropertyName(foundDisc.getPropertyName());
|
||||
@@ -3667,7 +3695,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
boolean matched = false;
|
||||
for (MappedModel uniqueDescendant : uniqueDescendants) {
|
||||
if (uniqueDescendant.getMappingName().equals(otherDescendant.getMappingName())
|
||||
|| (uniqueDescendant.getModelName().equals(otherDescendant.getModelName()))) {
|
||||
|| (uniqueDescendant.getModelName().equals(otherDescendant.getModelName()))) {
|
||||
matched = true;
|
||||
break;
|
||||
}
|
||||
@@ -3865,9 +3893,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
property.isNullable = property.isNullable ||
|
||||
!(ModelUtils.isComposedSchema(p)) ||
|
||||
p.getAllOf() == null ||
|
||||
p.getAllOf().size() == 0;
|
||||
!(ModelUtils.isComposedSchema(p)) ||
|
||||
p.getAllOf() == null ||
|
||||
p.getAllOf().size() == 0;
|
||||
if (languageSpecificPrimitives.contains(property.dataType)) {
|
||||
property.isPrimitiveType = true;
|
||||
}
|
||||
@@ -3943,7 +3971,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
return fromProperty(name, p, required, false);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* TODO remove this in 7.0.0 as a breaking change
|
||||
* This method was kept when required was added to the fromProperty signature
|
||||
@@ -4124,7 +4151,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
if (referencedSchema.getNullable() != null) {
|
||||
property.isNullable = referencedSchema.getNullable();
|
||||
} else if (referencedSchema.getExtensions() != null &&
|
||||
referencedSchema.getExtensions().containsKey(X_NULLABLE)) {
|
||||
referencedSchema.getExtensions().containsKey(X_NULLABLE)) {
|
||||
property.isNullable = (Boolean) referencedSchema.getExtensions().get(X_NULLABLE);
|
||||
}
|
||||
|
||||
@@ -4208,9 +4235,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
boolean isAnyTypeWithNothingElseSet = (ModelUtils.isAnyType(p) &&
|
||||
(p.getProperties() == null || p.getProperties().isEmpty()) &&
|
||||
!ModelUtils.isComposedSchema(p) &&
|
||||
p.getAdditionalProperties() == null && p.getNot() == null && p.getEnum() == null);
|
||||
(p.getProperties() == null || p.getProperties().isEmpty()) &&
|
||||
!ModelUtils.isComposedSchema(p) &&
|
||||
p.getAdditionalProperties() == null && p.getNot() == null && p.getEnum() == null);
|
||||
|
||||
if (!ModelUtils.isArraySchema(p) && !ModelUtils.isMapSchema(p) && !ModelUtils.isFreeFormObject(p, openAPI) && !isAnyTypeWithNothingElseSet) {
|
||||
/* schemas that are not Array, not ModelUtils.isMapSchema, not isFreeFormObject, not AnyType with nothing else set
|
||||
@@ -4289,7 +4316,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
* update container's default to empty container according rules provided by the user.
|
||||
*
|
||||
* @param cp codegen property
|
||||
* @param p schema
|
||||
* @param p schema
|
||||
*/
|
||||
void updateDefaultToEmptyContainer(CodegenProperty cp, Schema p) {
|
||||
if (cp.isArray) {
|
||||
@@ -4331,7 +4358,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
void parseDefaultToEmptyContainer(String input) {
|
||||
String[] inputs = ((String) input).split("[|]");
|
||||
String containerType;
|
||||
for (String rule: inputs) {
|
||||
for (String rule : inputs) {
|
||||
if (StringUtils.isEmpty(rule)) {
|
||||
LOGGER.error("updateDefaultToEmptyContainer: Skipped empty input in `{}`.", input);
|
||||
continue;
|
||||
@@ -4356,7 +4383,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
LOGGER.error("Skipped invalid container type `{}` in `{}`.", containerType, input);
|
||||
}
|
||||
} else if (rule.endsWith("?")) { // optional
|
||||
containerType = rule.substring(0, rule.length()-1);
|
||||
containerType = rule.substring(0, rule.length() - 1);
|
||||
if ("array".equalsIgnoreCase(containerType)) {
|
||||
arrayOptionalDefaultToEmpty = true;
|
||||
} else if ("map".equalsIgnoreCase(containerType)) {
|
||||
@@ -4466,7 +4493,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected CodegenProperty getMostInnerItems(CodegenProperty property) {
|
||||
CodegenProperty currentProperty = property;
|
||||
while (currentProperty != null && (Boolean.TRUE.equals(currentProperty.isMap)
|
||||
|| Boolean.TRUE.equals(currentProperty.isArray)) && currentProperty.items != null) {
|
||||
|| Boolean.TRUE.equals(currentProperty.isArray)) && currentProperty.items != null) {
|
||||
currentProperty = currentProperty.items;
|
||||
}
|
||||
return currentProperty;
|
||||
@@ -4486,7 +4513,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected void updateDataTypeWithEnumForArray(CodegenProperty property) {
|
||||
CodegenProperty baseItem = property.items;
|
||||
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
baseItem = baseItem.items;
|
||||
}
|
||||
if (baseItem != null) {
|
||||
@@ -4514,7 +4541,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
protected void updateDataTypeWithEnumForMap(CodegenProperty property) {
|
||||
CodegenProperty baseItem = property.items;
|
||||
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
baseItem = baseItem.items;
|
||||
}
|
||||
|
||||
@@ -4575,9 +4602,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
* @param methodResponse the default ApiResponse for the endpoint
|
||||
*/
|
||||
protected void handleMethodResponse(Operation operation,
|
||||
Map<String, Schema> schemas,
|
||||
CodegenOperation op,
|
||||
ApiResponse methodResponse) {
|
||||
Map<String, Schema> schemas,
|
||||
CodegenOperation op,
|
||||
ApiResponse methodResponse) {
|
||||
handleMethodResponse(operation, schemas, op, methodResponse, Collections.emptyMap());
|
||||
}
|
||||
|
||||
@@ -4591,10 +4618,10 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
* @param schemaMappings mappings of external types to be omitted by unaliasing
|
||||
*/
|
||||
protected void handleMethodResponse(Operation operation,
|
||||
Map<String, Schema> schemas,
|
||||
CodegenOperation op,
|
||||
ApiResponse methodResponse,
|
||||
Map<String, String> schemaMappings) {
|
||||
Map<String, Schema> schemas,
|
||||
CodegenOperation op,
|
||||
ApiResponse methodResponse,
|
||||
Map<String, String> schemaMappings) {
|
||||
ApiResponse response = ModelUtils.getReferencedApiResponse(openAPI, methodResponse);
|
||||
Schema responseSchema = unaliasSchema(ModelUtils.getSchemaFromResponse(openAPI, response));
|
||||
|
||||
@@ -4663,9 +4690,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
*/
|
||||
@Override
|
||||
public CodegenOperation fromOperation(String path,
|
||||
String httpMethod,
|
||||
Operation operation,
|
||||
List<Server> servers) {
|
||||
String httpMethod,
|
||||
Operation operation,
|
||||
List<Server> servers) {
|
||||
LOGGER.debug("fromOperation => operation: {}", operation);
|
||||
if (operation == null)
|
||||
throw new RuntimeException("operation cannot be null in fromOperation");
|
||||
@@ -4733,8 +4760,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
r.setContent(getContent(response.getContent(), imports, mediaTypeSchemaSuffix));
|
||||
|
||||
if (r.baseType != null &&
|
||||
!defaultIncludes.contains(r.baseType) &&
|
||||
!languageSpecificPrimitives.contains(r.baseType)) {
|
||||
!defaultIncludes.contains(r.baseType) &&
|
||||
!languageSpecificPrimitives.contains(r.baseType)) {
|
||||
imports.add(r.baseType);
|
||||
}
|
||||
|
||||
@@ -4756,14 +4783,14 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
// check if any 4xx or 5xx response has an error response object defined
|
||||
if ((Boolean.TRUE.equals(r.is4xx) || Boolean.TRUE.equals(r.is5xx)) &&
|
||||
Boolean.FALSE.equals(r.primitiveType) && Boolean.FALSE.equals(r.simpleType)) {
|
||||
Boolean.FALSE.equals(r.primitiveType) && Boolean.FALSE.equals(r.simpleType)) {
|
||||
op.hasErrorResponseObject = Boolean.TRUE;
|
||||
}
|
||||
}
|
||||
|
||||
// check if the operation can both return a 2xx response with a body and without
|
||||
if (op.responses.stream().anyMatch(response -> response.is2xx && response.dataType != null) &&
|
||||
op.responses.stream().anyMatch(response -> response.is2xx && response.dataType == null)) {
|
||||
op.responses.stream().anyMatch(response -> response.is2xx && response.dataType == null)) {
|
||||
op.isResponseOptional = Boolean.TRUE;
|
||||
}
|
||||
|
||||
@@ -4836,8 +4863,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
contentType = contentType.toLowerCase(Locale.ROOT);
|
||||
}
|
||||
if (contentType != null &&
|
||||
((!(this instanceof RustAxumServerCodegen) && contentType.startsWith("application/x-www-form-urlencoded")) ||
|
||||
contentType.startsWith("multipart"))) {
|
||||
((!(this instanceof RustAxumServerCodegen) && contentType.startsWith("application/x-www-form-urlencoded")) ||
|
||||
contentType.startsWith("multipart"))) {
|
||||
// process form parameters
|
||||
formParams = fromRequestBodyToFormParameters(requestBody, imports);
|
||||
op.isMultipart = contentType.startsWith("multipart");
|
||||
@@ -5027,23 +5054,23 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
r.code = responseCode;
|
||||
switch (r.code.charAt(0)) {
|
||||
|
||||
case '1':
|
||||
r.is1xx = true;
|
||||
break;
|
||||
case '2':
|
||||
r.is2xx = true;
|
||||
break;
|
||||
case '3':
|
||||
r.is3xx = true;
|
||||
break;
|
||||
case '4':
|
||||
r.is4xx = true;
|
||||
break;
|
||||
case '5':
|
||||
r.is5xx = true;
|
||||
break;
|
||||
default:
|
||||
throw new RuntimeException("Invalid response code " + responseCode);
|
||||
case '1':
|
||||
r.is1xx = true;
|
||||
break;
|
||||
case '2':
|
||||
r.is2xx = true;
|
||||
break;
|
||||
case '3':
|
||||
r.is3xx = true;
|
||||
break;
|
||||
case '4':
|
||||
r.is4xx = true;
|
||||
break;
|
||||
case '5':
|
||||
r.is5xx = true;
|
||||
break;
|
||||
default:
|
||||
throw new RuntimeException("Invalid response code " + responseCode);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5273,7 +5300,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
LOGGER.debug("debugging codegenParameter return: {}", codegenParameter);
|
||||
}
|
||||
|
||||
|
||||
private void updateParameterForMap(CodegenParameter codegenParameter, Schema parameterSchema, Set<String> imports) {
|
||||
CodegenProperty codegenProperty = fromProperty("inner", ModelUtils.getAdditionalProperties(parameterSchema), false);
|
||||
codegenParameter.items = codegenProperty;
|
||||
@@ -5853,7 +5879,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
*/
|
||||
protected boolean needToImport(String type) {
|
||||
return StringUtils.isNotBlank(type) && !defaultIncludes.contains(type)
|
||||
&& !languageSpecificPrimitives.contains(type);
|
||||
&& !languageSpecificPrimitives.contains(type);
|
||||
}
|
||||
|
||||
@SuppressWarnings("static-method")
|
||||
@@ -6062,7 +6088,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
}
|
||||
|
||||
protected void addVars(CodegenModel m, Map<String, Schema> properties, List<String> required,
|
||||
Map<String, Schema> allProperties, List<String> allRequired) {
|
||||
Map<String, Schema> allProperties, List<String> allRequired) {
|
||||
|
||||
m.hasRequired = false;
|
||||
m.hasReadOnly = false;
|
||||
@@ -6265,7 +6291,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
// allOf with a single item
|
||||
if (schema.getAllOf() != null && schema.getAllOf().size() == 1
|
||||
&& schema.getAllOf().get(0) instanceof Schema) {
|
||||
&& schema.getAllOf().get(0) instanceof Schema) {
|
||||
schema = unaliasSchema((Schema) schema.getAllOf().get(0));
|
||||
schema = ModelUtils.getReferencedSchema(this.openAPI, schema);
|
||||
}
|
||||
@@ -7040,7 +7066,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* reads propertyKey from additionalProperties, converts it to a boolean and
|
||||
* writes it back to additionalProperties to be usable as a boolean in
|
||||
@@ -7115,6 +7140,69 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
this.ignoreFilePathOverride = ignoreFileOverride;
|
||||
}
|
||||
|
||||
public List<String> getPropertyAsStringList(String propertyKey) {
|
||||
final Object value = additionalProperties.get(propertyKey);
|
||||
return getObjectAsStringList(value);
|
||||
}
|
||||
|
||||
public static List<String> getObjectAsStringList(Object value) {
|
||||
if (value instanceof List) {
|
||||
List<?> list = (List<?>) value;
|
||||
List<String> stringList = new ArrayList<>();
|
||||
for (Object item : list) {
|
||||
if (item != null) {
|
||||
stringList.add(item.toString());
|
||||
}
|
||||
}
|
||||
return stringList;
|
||||
} else if (value instanceof String) {
|
||||
return Collections.singletonList((String) value);
|
||||
}
|
||||
return Collections.emptyList();
|
||||
}
|
||||
|
||||
public Map<String, String> getPropertyAsStringMap(String propertyKey) {
|
||||
final Object value = additionalProperties.get(propertyKey);
|
||||
return getObjectAsStringMap(value);
|
||||
}
|
||||
|
||||
public static Map<String, String> getObjectAsStringMap(Object value) {
|
||||
if (value instanceof Map) {
|
||||
Map<?, ?> rawMap = (Map<?, ?>) value;
|
||||
Map<String, String> stringMap = new HashMap<>();
|
||||
for (Entry<?, ?> entry : rawMap.entrySet()) {
|
||||
stringMap.put(String.valueOf(entry.getKey()), String.valueOf(entry.getValue()));
|
||||
}
|
||||
return stringMap;
|
||||
}
|
||||
return Collections.emptyMap();
|
||||
}
|
||||
|
||||
public Map<String, List<String>> getPropertyAsStringListMap(String propertyKey) {
|
||||
final Object value = additionalProperties.get(propertyKey);
|
||||
return getObjectAsStringListMap(value);
|
||||
}
|
||||
|
||||
public static Map<String, List<String>> getObjectAsStringListMap(Object value) {
|
||||
if (value instanceof Map) {
|
||||
Map<?, ?> rawMap = (Map<?, ?>) value;
|
||||
Map<String, List<String>> stringMap = new HashMap<>();
|
||||
for (Entry<?, ?> entry : rawMap.entrySet()) {
|
||||
Object entryValue = entry.getValue();
|
||||
if (entryValue instanceof List) {
|
||||
List<String> stringList = ((List<?>) entryValue).stream()
|
||||
.map(String::valueOf)
|
||||
.collect(Collectors.toList());
|
||||
stringMap.put(String.valueOf(entry.getKey()), stringList);
|
||||
} else {
|
||||
stringMap.put(String.valueOf(entry.getKey()), Collections.singletonList(String.valueOf(entryValue)));
|
||||
}
|
||||
}
|
||||
return stringMap;
|
||||
}
|
||||
return Collections.emptyMap();
|
||||
}
|
||||
|
||||
public boolean convertPropertyToBoolean(String propertyKey) {
|
||||
final Object booleanValue = additionalProperties.get(propertyKey);
|
||||
boolean result = Boolean.FALSE;
|
||||
@@ -7218,8 +7306,8 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
for (String consume : consumesInfo) {
|
||||
if (consume != null &&
|
||||
(consume.toLowerCase(Locale.ROOT).startsWith("application/x-www-form-urlencoded") ||
|
||||
consume.toLowerCase(Locale.ROOT).startsWith("multipart"))) {
|
||||
(consume.toLowerCase(Locale.ROOT).startsWith("application/x-www-form-urlencoded") ||
|
||||
consume.toLowerCase(Locale.ROOT).startsWith("multipart"))) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -7338,7 +7426,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
Schema original = null;
|
||||
// check if it's allOf (only 1 sub schema) with or without default/nullable/etc set in the top level
|
||||
if (ModelUtils.isAllOf(schema) && schema.getAllOf().size() == 1 &&
|
||||
(ModelUtils.getType(schema) == null || "object".equals(ModelUtils.getType(schema)))) {
|
||||
(ModelUtils.getType(schema) == null || "object".equals(ModelUtils.getType(schema)))) {
|
||||
if (schema.getAllOf().get(0) instanceof Schema) {
|
||||
original = schema;
|
||||
schema = (Schema) schema.getAllOf().get(0);
|
||||
@@ -7630,9 +7718,9 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
codegenModelDescription = codegenModel.description;
|
||||
} else {
|
||||
LOGGER.warn("The following schema has undefined (null) baseType. " +
|
||||
"It could be due to form parameter defined in OpenAPI v2 spec with incorrect consumes. " +
|
||||
"A correct 'consumes' for form parameters should be " +
|
||||
"'application/x-www-form-urlencoded' or 'multipart/?'");
|
||||
"It could be due to form parameter defined in OpenAPI v2 spec with incorrect consumes. " +
|
||||
"A correct 'consumes' for form parameters should be " +
|
||||
"'application/x-www-form-urlencoded' or 'multipart/?'");
|
||||
LOGGER.warn("schema: {}", schema);
|
||||
LOGGER.warn("codegenModel is null. Default to UNKNOWN_BASE_TYPE");
|
||||
codegenModelName = "UNKNOWN_BASE_TYPE";
|
||||
@@ -7696,7 +7784,6 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
innerCp = innerCp.items;
|
||||
}
|
||||
|
||||
|
||||
if (StringUtils.isEmpty(bodyParameterName)) {
|
||||
codegenParameter.baseName = "request_body";
|
||||
} else {
|
||||
@@ -7991,7 +8078,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
Schema original = null;
|
||||
// check if it's allOf (only 1 sub schema) with or without default/nullable/etc set in the top level
|
||||
if (ModelUtils.isAllOf(schema) && schema.getAllOf().size() == 1 &&
|
||||
(ModelUtils.getType(schema) == null || "object".equals(ModelUtils.getType(schema)))) {
|
||||
(ModelUtils.getType(schema) == null || "object".equals(ModelUtils.getType(schema)))) {
|
||||
if (schema.getAllOf().get(0) instanceof Schema) {
|
||||
original = schema;
|
||||
schema = (Schema) schema.getAllOf().get(0);
|
||||
@@ -8379,7 +8466,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
int exitValue = p.exitValue();
|
||||
if (exitValue != 0) {
|
||||
try (InputStreamReader inputStreamReader = new InputStreamReader(p.getErrorStream(), StandardCharsets.UTF_8);
|
||||
BufferedReader br = new BufferedReader(inputStreamReader)) {
|
||||
BufferedReader br = new BufferedReader(inputStreamReader)) {
|
||||
StringBuilder sb = new StringBuilder();
|
||||
String line;
|
||||
while ((line = br.readLine()) != null) {
|
||||
@@ -8548,6 +8635,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
*/
|
||||
@Getter
|
||||
private static class SanitizeNameOptions {
|
||||
|
||||
public SanitizeNameOptions(String name, String removeCharRegEx, List<String> exceptions) {
|
||||
this.name = name;
|
||||
this.removeCharRegEx = removeCharRegEx;
|
||||
@@ -8564,12 +8652,14 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o) {
|
||||
if (this == o) return true;
|
||||
if (o == null || getClass() != o.getClass()) return false;
|
||||
if (this == o)
|
||||
return true;
|
||||
if (o == null || getClass() != o.getClass())
|
||||
return false;
|
||||
SanitizeNameOptions that = (SanitizeNameOptions) o;
|
||||
return Objects.equals(getName(), that.getName()) &&
|
||||
Objects.equals(getRemoveCharRegEx(), that.getRemoveCharRegEx()) &&
|
||||
Objects.equals(getExceptions(), that.getExceptions());
|
||||
Objects.equals(getRemoveCharRegEx(), that.getRemoveCharRegEx()) &&
|
||||
Objects.equals(getExceptions(), that.getExceptions());
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -8675,7 +8765,7 @@ public class DefaultCodegen implements CodegenConfig {
|
||||
i += 1;
|
||||
|
||||
if (dataTypeSet.contains(cp.dataType)
|
||||
|| (isTypeErasedGenerics() && dataTypeSet.contains(cp.baseType))) {
|
||||
|| (isTypeErasedGenerics() && dataTypeSet.contains(cp.baseType))) {
|
||||
// add "x-duplicated-data-type" to indicate if the (base) dataType already occurs before
|
||||
// in other sub-schemas of allOf/anyOf/oneOf
|
||||
cp.vendorExtensions.putIfAbsent("x-duplicated-data-type", true);
|
||||
|
||||
@@ -33,6 +33,7 @@ import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.lang.reflect.Constructor;
|
||||
import java.math.BigDecimal;
|
||||
import java.util.*;
|
||||
import java.util.function.Function;
|
||||
import java.util.stream.Collectors;
|
||||
@@ -803,6 +804,13 @@ public class OpenAPINormalizer {
|
||||
* @param schema Schema
|
||||
*/
|
||||
protected void normalizeReferenceSchema(Schema schema) {
|
||||
if (schema.getType() != null || schema.getTypes() != null && !schema.getTypes().isEmpty()) {
|
||||
// clears type(s) given that $ref is set
|
||||
schema.setType(null);
|
||||
schema.setTypes(null);
|
||||
LOGGER.warn("Type(s) cleared (set to null) given $ref is set to {}.", schema.get$ref());
|
||||
}
|
||||
|
||||
if (schema.getTitle() != null || schema.getDescription() != null
|
||||
|| schema.getNullable() != null || schema.getDefault() != null || schema.getDeprecated() != null
|
||||
|| schema.getMaximum() != null || schema.getMinimum() != null
|
||||
@@ -1782,6 +1790,8 @@ public class OpenAPINormalizer {
|
||||
return null;
|
||||
}
|
||||
|
||||
normalizeExclusiveMinMax31(schema);
|
||||
|
||||
if (schema instanceof JsonSchema &&
|
||||
schema.get$schema() == null &&
|
||||
schema.getTypes() == null && schema.getType() == null) {
|
||||
@@ -1876,6 +1886,51 @@ public class OpenAPINormalizer {
|
||||
return schema;
|
||||
}
|
||||
|
||||
private void normalizeExclusiveMinMax31(Schema<?> schema) {
|
||||
if (schema == null || schema.get$ref() != null) return;
|
||||
|
||||
// OAS 3.1 numeric exclusiveMinimum
|
||||
BigDecimal exclusiveMinValue = schema.getExclusiveMinimumValue();
|
||||
if (exclusiveMinValue != null) {
|
||||
BigDecimal minimum = schema.getMinimum();
|
||||
|
||||
if (minimum == null) {
|
||||
schema.setMinimum(exclusiveMinValue);
|
||||
schema.setExclusiveMinimum(Boolean.TRUE);
|
||||
} else {
|
||||
int cmp = exclusiveMinValue.compareTo(minimum);
|
||||
|
||||
if (cmp > 0) {
|
||||
schema.setMinimum(exclusiveMinValue);
|
||||
schema.setExclusiveMinimum(Boolean.TRUE);
|
||||
} else if (cmp == 0) {
|
||||
schema.setExclusiveMinimum(Boolean.TRUE);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// OAS 3.1 numeric exclusiveMaximum
|
||||
BigDecimal exclusiveMaxValue = schema.getExclusiveMaximumValue();
|
||||
if (exclusiveMaxValue != null) {
|
||||
BigDecimal maximum = schema.getMaximum();
|
||||
|
||||
if (maximum == null) {
|
||||
schema.setMaximum(exclusiveMaxValue);
|
||||
schema.setExclusiveMaximum(Boolean.TRUE);
|
||||
} else {
|
||||
int cmp = exclusiveMaxValue.compareTo(maximum);
|
||||
|
||||
if (cmp < 0) {
|
||||
schema.setMaximum(exclusiveMaxValue);
|
||||
schema.setExclusiveMaximum(Boolean.TRUE);
|
||||
} else if (cmp == 0) {
|
||||
schema.setExclusiveMaximum(Boolean.TRUE);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ===================== end of rules =====================
|
||||
|
||||
protected static class Filter {
|
||||
|
||||
@@ -56,6 +56,7 @@ import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import javax.lang.model.SourceVersion;
|
||||
|
||||
import java.io.File;
|
||||
import java.time.LocalDate;
|
||||
import java.time.ZoneId;
|
||||
@@ -63,6 +64,7 @@ import java.time.ZonedDateTime;
|
||||
import java.time.format.DateTimeFormatter;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.ConcurrentSkipListSet;
|
||||
import java.util.function.Predicate;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.stream.Collectors;
|
||||
@@ -90,6 +92,8 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
|
||||
public static final String BOOLEAN_GETTER_PREFIX = "booleanGetterPrefix";
|
||||
public static final String IGNORE_ANYOF_IN_ENUM = "ignoreAnyOfInEnum";
|
||||
public static final String ADDITIONAL_MODEL_TYPE_ANNOTATIONS = "additionalModelTypeAnnotations";
|
||||
public static final String X_IMPLEMENTS_SKIP = "xImplementsSkip";
|
||||
public static final String SCHEMA_IMPLEMENTS = "schemaImplements";
|
||||
public static final String ADDITIONAL_ONE_OF_TYPE_ANNOTATIONS = "additionalOneOfTypeAnnotations";
|
||||
public static final String ADDITIONAL_ENUM_TYPE_ANNOTATIONS = "additionalEnumTypeAnnotations";
|
||||
public static final String DISCRIMINATOR_CASE_SENSITIVE = "discriminatorCaseSensitive";
|
||||
@@ -178,6 +182,12 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
|
||||
@Setter protected boolean parentOverridden = false;
|
||||
@Getter @Setter
|
||||
protected List<String> additionalModelTypeAnnotations = new LinkedList<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected List<String> xImplementsSkip = new ArrayList<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected Map<String, List<String>> schemaImplements = new HashMap<>();
|
||||
protected Map<String, Boolean> lombokAnnotations = null;
|
||||
@Getter @Setter
|
||||
protected List<String> additionalOneOfTypeAnnotations = new LinkedList<>();
|
||||
@@ -450,6 +460,12 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
|
||||
convertPropertyToTypeAndWriteBack(ADDITIONAL_ENUM_TYPE_ANNOTATIONS,
|
||||
annotations -> Arrays.asList(annotations.split(";")),
|
||||
this::setAdditionalEnumTypeAnnotations);
|
||||
if (additionalProperties.containsKey(X_IMPLEMENTS_SKIP)) {
|
||||
this.setXImplementsSkip(getPropertyAsStringList(X_IMPLEMENTS_SKIP));
|
||||
}
|
||||
if (additionalProperties.containsKey(SCHEMA_IMPLEMENTS)) {
|
||||
this.setSchemaImplements(getPropertyAsStringListMap(SCHEMA_IMPLEMENTS));
|
||||
}
|
||||
|
||||
if (additionalProperties.containsKey(CodegenConstants.INVOKER_PACKAGE)) {
|
||||
this.setInvokerPackage((String) additionalProperties.get(CodegenConstants.INVOKER_PACKAGE));
|
||||
@@ -1998,13 +2014,63 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
|
||||
listIterator.add(newImportMap);
|
||||
}
|
||||
}
|
||||
|
||||
// add x-implements for serializable to all models
|
||||
// make sure the x-implements is always a List and always at least empty
|
||||
for (ModelMap mo : objs.getModels()) {
|
||||
CodegenModel cm = mo.getModel();
|
||||
if (this.serializableModel) {
|
||||
cm.getVendorExtensions().putIfAbsent(X_IMPLEMENTS, new ArrayList<String>());
|
||||
((ArrayList<String>) cm.getVendorExtensions().get(X_IMPLEMENTS)).add("Serializable");
|
||||
if (cm.getVendorExtensions().containsKey(X_IMPLEMENTS)) {
|
||||
List<String> xImplements = getObjectAsStringList(cm.getVendorExtensions().get(X_IMPLEMENTS));
|
||||
cm.getVendorExtensions().replace(X_IMPLEMENTS, xImplements);
|
||||
} else {
|
||||
cm.getVendorExtensions().put(X_IMPLEMENTS, new ArrayList<String>());
|
||||
}
|
||||
}
|
||||
|
||||
// skip interfaces predefined in open api spec in x-implements via additional property xImplementsSkip
|
||||
if (!this.xImplementsSkip.isEmpty()) {
|
||||
for (ModelMap mo : objs.getModels()) {
|
||||
CodegenModel cm = mo.getModel();
|
||||
if (!getObjectAsStringList(cm.getVendorExtensions().get(X_IMPLEMENTS)).isEmpty()) {
|
||||
List<String> xImplementsInModelOriginal = getObjectAsStringList(cm.getVendorExtensions().get(X_IMPLEMENTS));
|
||||
List<String> xImplementsInModelSkipped = xImplementsInModelOriginal
|
||||
.stream()
|
||||
.filter(o -> this.xImplementsSkip.contains(o))
|
||||
.collect(Collectors.toList());
|
||||
if (!xImplementsInModelSkipped.isEmpty()) {
|
||||
LOGGER.info("Following interfaces configured via config option '{}' will be skipped for model {}: {}", X_IMPLEMENTS_SKIP, cm.classname, xImplementsInModelSkipped);
|
||||
}
|
||||
List<String> xImplementsInModelProcessed = xImplementsInModelOriginal.stream()
|
||||
.filter(Predicate.not(xImplementsInModelSkipped::contains))
|
||||
.collect(Collectors.toList());
|
||||
// implement only the non-skipped interfaces
|
||||
cm.getVendorExtensions().replace(X_IMPLEMENTS, xImplementsInModelProcessed);
|
||||
}
|
||||
}
|
||||
}
|
||||
// add interfaces defined outside of open api spec
|
||||
if (!this.schemaImplements.isEmpty()) {
|
||||
for (ModelMap mo : objs.getModels()) {
|
||||
CodegenModel cm = mo.getModel();
|
||||
if (this.schemaImplements.containsKey(cm.getSchemaName())) {
|
||||
LOGGER.info("Adding interface(s) {} configured via config option '{}' to model {}", this.schemaImplements.get(cm.getSchemaName()), SCHEMA_IMPLEMENTS, cm.classname);
|
||||
List<String> xImplementsInModel = getObjectAsStringList(cm.getVendorExtensions().get(X_IMPLEMENTS));
|
||||
List<String> schemaImplements = this.schemaImplements.get(cm.getSchemaName());
|
||||
List<String> combinedSchemaImplements = Stream.concat(xImplementsInModel.stream(), schemaImplements.stream())
|
||||
.collect(Collectors.toList());
|
||||
// Add all the interfaces combined
|
||||
cm.getVendorExtensions().replace(X_IMPLEMENTS, combinedSchemaImplements);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// add Serializable to x-implements to all models if configured
|
||||
if (this.serializableModel) {
|
||||
for (ModelMap mo : objs.getModels()) {
|
||||
CodegenModel cm = mo.getModel();
|
||||
List<String> xImplements = new ArrayList<>(getObjectAsStringList(cm.getVendorExtensions().get(X_IMPLEMENTS)));
|
||||
if (!xImplements.contains("Serializable")) {
|
||||
xImplements.add("Serializable");
|
||||
}
|
||||
cm.getVendorExtensions().replace(X_IMPLEMENTS, xImplements);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -56,6 +56,10 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
|
||||
|
||||
public static final String JAVAX_PACKAGE = "javaxPackage";
|
||||
public static final String USE_JAKARTA_EE = "useJakartaEe";
|
||||
public static final String SCHEMA_IMPLEMENTS = "schemaImplements";
|
||||
public static final String SCHEMA_IMPLEMENTS_FIELDS = "schemaImplementsFields";
|
||||
public static final String X_KOTLIN_IMPLEMENTS_SKIP = "xKotlinImplementsSkip";
|
||||
public static final String X_KOTLIN_IMPLEMENTS_FIELDS_SKIP = "xKotlinImplementsFieldsSkip";
|
||||
|
||||
private final Logger LOGGER = LoggerFactory.getLogger(AbstractKotlinCodegen.class);
|
||||
|
||||
@@ -88,6 +92,18 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
|
||||
private final Map<String, String> schemaKeyToModelNameCache = new HashMap<>();
|
||||
@Getter @Setter
|
||||
protected List<String> additionalModelTypeAnnotations = new LinkedList<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected Map<String, List<String>> schemaImplements = new HashMap<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected Map<String, List<String>> schemaImplementsFields = new HashMap<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected List<String> xKotlinImplementsSkip = new ArrayList<>();
|
||||
@Getter
|
||||
@Setter
|
||||
protected Map<String, List<String>> xKotlinImplementsFieldsSkip = new HashMap<>();
|
||||
|
||||
public AbstractKotlinCodegen() {
|
||||
super();
|
||||
@@ -513,7 +529,19 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
|
||||
|
||||
if (additionalProperties.containsKey(ADDITIONAL_MODEL_TYPE_ANNOTATIONS)) {
|
||||
String additionalAnnotationsList = additionalProperties.get(ADDITIONAL_MODEL_TYPE_ANNOTATIONS).toString();
|
||||
this.setAdditionalModelTypeAnnotations(Arrays.asList(additionalAnnotationsList.trim().split("\\s*(;|\\r?\\n)\\s*")));
|
||||
this.setAdditionalModelTypeAnnotations(Arrays.asList(SPLIT_ON_SEMICOLON_OR_NEWLINE_REGEX.split(additionalAnnotationsList.trim())));
|
||||
}
|
||||
if (additionalProperties.containsKey(SCHEMA_IMPLEMENTS)) {
|
||||
this.setSchemaImplements(getPropertyAsStringListMap(SCHEMA_IMPLEMENTS));
|
||||
}
|
||||
if (additionalProperties.containsKey(SCHEMA_IMPLEMENTS_FIELDS)) {
|
||||
this.setSchemaImplementsFields(getPropertyAsStringListMap(SCHEMA_IMPLEMENTS_FIELDS));
|
||||
}
|
||||
if (additionalProperties.containsKey(X_KOTLIN_IMPLEMENTS_SKIP)) {
|
||||
this.setXKotlinImplementsSkip(getPropertyAsStringList(X_KOTLIN_IMPLEMENTS_SKIP));
|
||||
}
|
||||
if (additionalProperties.containsKey(X_KOTLIN_IMPLEMENTS_FIELDS_SKIP)) {
|
||||
this.setXKotlinImplementsFieldsSkip(getPropertyAsStringListMap(X_KOTLIN_IMPLEMENTS_FIELDS_SKIP));
|
||||
}
|
||||
|
||||
additionalProperties.put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, getSortParamsByRequiredFlag());
|
||||
@@ -839,16 +867,52 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
|
||||
@Override
|
||||
public CodegenModel fromModel(String name, Schema schema) {
|
||||
CodegenModel m = super.fromModel(name, schema);
|
||||
List<String> implementedInterfacesClasses = (List<String>) m.getVendorExtensions().getOrDefault(VendorExtension.X_KOTLIN_IMPLEMENTS.getName(), List.of());
|
||||
List<String> implementedInterfacesFields = Optional.ofNullable((List<String>) m.getVendorExtensions().get(VendorExtension.X_KOTLIN_IMPLEMENTS_FIELDS.getName()))
|
||||
m.getVendorExtensions().putIfAbsent(VendorExtension.X_KOTLIN_IMPLEMENTS.getName(), List.of());
|
||||
List<String> schemaImplementedInterfacesClasses = this.getSchemaImplements().getOrDefault(m.getSchemaName(), List.of());
|
||||
List<String> schemaImplementedInterfacesFields = this.getSchemaImplementsFields().getOrDefault(m.getSchemaName(), List.of());
|
||||
List<String> vendorExtensionImplementedInterfacesClasses = (List<String>) m.getVendorExtensions().get(VendorExtension.X_KOTLIN_IMPLEMENTS.getName());
|
||||
List<String> interfacesToSkip = this.getXKotlinImplementsSkip().stream()
|
||||
.filter(vendorExtensionImplementedInterfacesClasses::contains)
|
||||
.collect(Collectors.toList());
|
||||
if (!interfacesToSkip.isEmpty()) {
|
||||
LOGGER.info("Interface(s) {} in model {} are skipped from being marked as implemented via config option '{}'.",
|
||||
interfacesToSkip, name, X_KOTLIN_IMPLEMENTS_SKIP);
|
||||
}
|
||||
List<String> vendorExtensionImplementedInterfacesClassesFiltered = vendorExtensionImplementedInterfacesClasses.stream()
|
||||
.filter(interfaceName -> !interfacesToSkip.contains(interfaceName))
|
||||
.collect(Collectors.toList());
|
||||
List<String> vendorExtensionImplementedInterfacesFields = Optional.ofNullable((List<String>) m.getVendorExtensions().get(VendorExtension.X_KOTLIN_IMPLEMENTS_FIELDS.getName()))
|
||||
.map(xKotlinImplementsFields -> {
|
||||
if (implementedInterfacesClasses.isEmpty() && !xKotlinImplementsFields.isEmpty()) {
|
||||
if (vendorExtensionImplementedInterfacesClassesFiltered.isEmpty() && !xKotlinImplementsFields.isEmpty()) {
|
||||
LOGGER.warn("Annotating {} with {} without {} is not supported. {} will be ignored.",
|
||||
name, VendorExtension.X_KOTLIN_IMPLEMENTS_FIELDS.getName(), VendorExtension.X_KOTLIN_IMPLEMENTS.getName(),
|
||||
VendorExtension.X_KOTLIN_IMPLEMENTS_FIELDS.getName());
|
||||
}
|
||||
return xKotlinImplementsFields;
|
||||
}).orElse(List.of());
|
||||
List<String> fieldsToSkip = this.getXKotlinImplementsFieldsSkip().getOrDefault(m.getSchemaName(), List.of())
|
||||
.stream()
|
||||
.filter(vendorExtensionImplementedInterfacesFields::contains)
|
||||
.collect(Collectors.toList());
|
||||
if (!fieldsToSkip.isEmpty()) {
|
||||
LOGGER.info("Field(s) {} in model {} are skipped from being marked as inherited via config option '{}'.",
|
||||
fieldsToSkip, name, X_KOTLIN_IMPLEMENTS_FIELDS_SKIP);
|
||||
}
|
||||
List<String> vendorExtensionImplementedInterfacesFieldsFiltered = vendorExtensionImplementedInterfacesFields.stream()
|
||||
.filter(interfaceName -> !fieldsToSkip.contains(interfaceName))
|
||||
.collect(Collectors.toList());
|
||||
List<String> combinedImplementedInterfacesClasses = Stream.concat(vendorExtensionImplementedInterfacesClassesFiltered.stream(), schemaImplementedInterfacesClasses.stream())
|
||||
.distinct()
|
||||
.sorted()
|
||||
.collect(Collectors.toList());
|
||||
List<String> combinedImplementedInterfacesFields = Stream.concat(vendorExtensionImplementedInterfacesFieldsFiltered.stream(), schemaImplementedInterfacesFields.stream())
|
||||
.distinct()
|
||||
.collect(Collectors.toList());
|
||||
if (serializableModel && !combinedImplementedInterfacesClasses.contains("java.io.Serializable")) {
|
||||
combinedImplementedInterfacesClasses.add("java.io.Serializable");
|
||||
}
|
||||
m.getVendorExtensions().replace(VendorExtension.X_KOTLIN_IMPLEMENTS.getName(), combinedImplementedInterfacesClasses);
|
||||
LOGGER.info("Model {} implements interface(s): {}", name, combinedImplementedInterfacesClasses);
|
||||
m.optionalVars = m.optionalVars.stream().distinct().collect(Collectors.toList());
|
||||
// Update allVars/requiredVars/optionalVars with isInherited
|
||||
// Each of these lists contains elements that are similar, but they are all cloned
|
||||
@@ -865,7 +929,7 @@ public abstract class AbstractKotlinCodegen extends DefaultCodegen implements Co
|
||||
Stream.of(m.requiredVars, m.optionalVars)
|
||||
.flatMap(List::stream)
|
||||
.filter(p -> allVarsMap.containsKey(p.baseName)
|
||||
|| implementedInterfacesFields.contains(p.baseName)
|
||||
|| combinedImplementedInterfacesFields.contains(p.baseName)
|
||||
)
|
||||
.forEach(p -> p.isInherited = true);
|
||||
return m;
|
||||
|
||||
@@ -17,39 +17,65 @@
|
||||
|
||||
package org.openapitools.codegen.languages;
|
||||
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.apache.commons.io.FilenameUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.checkerframework.checker.nullness.qual.Nullable;
|
||||
import org.openapitools.codegen.*;
|
||||
import org.openapitools.codegen.CodegenConstants.ENUM_PROPERTY_NAMING_TYPE;
|
||||
import org.openapitools.codegen.CodegenConstants.MODEL_PROPERTY_NAMING_TYPE;
|
||||
import org.openapitools.codegen.CodegenConstants.PARAM_NAMING_TYPE;
|
||||
import org.openapitools.codegen.meta.features.*;
|
||||
import org.openapitools.codegen.model.ModelMap;
|
||||
import org.openapitools.codegen.model.ModelsMap;
|
||||
import org.openapitools.codegen.utils.ModelUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.form;
|
||||
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.simple;
|
||||
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
|
||||
import static org.openapitools.codegen.utils.StringUtils.camelize;
|
||||
import static org.openapitools.codegen.utils.StringUtils.underscore;
|
||||
|
||||
import java.io.File;
|
||||
import java.text.SimpleDateFormat;
|
||||
import java.util.*;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.Date;
|
||||
import java.util.EnumSet;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.TreeSet;
|
||||
import java.util.function.BiPredicate;
|
||||
import java.util.function.Function;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.form;
|
||||
import static org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen.ParameterExpander.ParamStyle.simple;
|
||||
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
|
||||
import static org.openapitools.codegen.utils.StringUtils.camelize;
|
||||
import static org.openapitools.codegen.utils.StringUtils.underscore;
|
||||
import org.apache.commons.io.FilenameUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.checkerframework.checker.nullness.qual.Nullable;
|
||||
import org.openapitools.codegen.CliOption;
|
||||
import org.openapitools.codegen.CodegenConfig;
|
||||
import org.openapitools.codegen.CodegenConstants;
|
||||
import org.openapitools.codegen.CodegenConstants.ENUM_PROPERTY_NAMING_TYPE;
|
||||
import org.openapitools.codegen.CodegenConstants.MODEL_PROPERTY_NAMING_TYPE;
|
||||
import org.openapitools.codegen.CodegenConstants.PARAM_NAMING_TYPE;
|
||||
import org.openapitools.codegen.CodegenModel;
|
||||
import org.openapitools.codegen.CodegenOperation;
|
||||
import org.openapitools.codegen.CodegenParameter;
|
||||
import org.openapitools.codegen.CodegenProperty;
|
||||
import org.openapitools.codegen.CodegenType;
|
||||
import org.openapitools.codegen.DefaultCodegen;
|
||||
import org.openapitools.codegen.GeneratorLanguage;
|
||||
import org.openapitools.codegen.meta.features.ClientModificationFeature;
|
||||
import org.openapitools.codegen.meta.features.DocumentationFeature;
|
||||
import org.openapitools.codegen.meta.features.GlobalFeature;
|
||||
import org.openapitools.codegen.meta.features.SchemaSupportFeature;
|
||||
import org.openapitools.codegen.meta.features.SecurityFeature;
|
||||
import org.openapitools.codegen.meta.features.WireFormatFeature;
|
||||
import org.openapitools.codegen.model.ModelMap;
|
||||
import org.openapitools.codegen.model.ModelsMap;
|
||||
import org.openapitools.codegen.utils.ModelUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
|
||||
public abstract class AbstractTypeScriptClientCodegen extends DefaultCodegen implements CodegenConfig {
|
||||
|
||||
@@ -1023,6 +1049,85 @@ public abstract class AbstractTypeScriptClientCodegen extends DefaultCodegen imp
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Override to fix the inner enum naming issue for maps/arrays of enums.
|
||||
* <p>
|
||||
* The parent implementation uses toEnumName(baseItem) which produces a generic name
|
||||
* like "InnerEnum" based on the inner item's name. This override first calculates
|
||||
* the correct property.enumName, then uses it in the datatypeWithEnum replacement.
|
||||
* </p>
|
||||
*
|
||||
* @param property Codegen property
|
||||
*/
|
||||
@Override
|
||||
protected void updateDataTypeWithEnumForArray(CodegenProperty property) {
|
||||
CodegenProperty baseItem = property.items;
|
||||
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
baseItem = baseItem.items;
|
||||
}
|
||||
|
||||
if (baseItem != null) {
|
||||
// First, set the property's enumName using the property itself (not the inner item)
|
||||
// This ensures the correct enum name (e.g., "OptionsEnum") is used
|
||||
// instead of the generic inner item name (e.g., "InnerEnum")
|
||||
property.enumName = toEnumName(property);
|
||||
|
||||
// Now use property.enumName for datatypeWithEnum
|
||||
property.datatypeWithEnum = property.datatypeWithEnum.replace(baseItem.baseType, property.enumName);
|
||||
|
||||
// set default value for variable with inner enum
|
||||
if (property.defaultValue != null) {
|
||||
property.defaultValue = property.defaultValue.replace(baseItem.baseType, property.enumName);
|
||||
}
|
||||
|
||||
updateCodegenPropertyEnum(property);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Override to fix the inner enum naming issue for map properties.
|
||||
* <p>
|
||||
* The parent implementation uses {@code toEnumName(baseItem)} which produces "InnerEnum"
|
||||
* for properties whose inner item has a generic name like "inner". We instead
|
||||
* calculate the enumName from the property itself first, then use it in the replacement.
|
||||
* </p>
|
||||
*
|
||||
* @param property Codegen property
|
||||
*/
|
||||
@Override
|
||||
protected void updateDataTypeWithEnumForMap(CodegenProperty property) {
|
||||
CodegenProperty baseItem = property.items;
|
||||
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|
||||
|| Boolean.TRUE.equals(baseItem.isArray))) {
|
||||
baseItem = baseItem.items;
|
||||
}
|
||||
|
||||
if (baseItem != null) {
|
||||
// First, set the property's enumName using the property itself (not the inner item)
|
||||
property.enumName = toEnumName(property);
|
||||
|
||||
// Replace only the LAST occurrence of baseType with enumName.
|
||||
// In map types, the value type appears last (after the key type),
|
||||
// so this approach is template-agnostic.
|
||||
String datatypeWithEnum = property.datatypeWithEnum;
|
||||
int lastIndex = datatypeWithEnum.lastIndexOf(baseItem.baseType);
|
||||
if (lastIndex >= 0) {
|
||||
property.datatypeWithEnum = datatypeWithEnum.substring(0, lastIndex)
|
||||
+ property.enumName
|
||||
+ datatypeWithEnum.substring(lastIndex + baseItem.baseType.length());
|
||||
}
|
||||
LOGGER.info("Updated datatypeWithEnum for map property '{}': {}", property.name, property.datatypeWithEnum);
|
||||
|
||||
// set default value for variable with inner enum
|
||||
if (property.defaultValue != null) {
|
||||
property.defaultValue = property.defaultValue.replace(baseItem.baseType, property.enumName);
|
||||
}
|
||||
|
||||
updateCodegenPropertyEnum(property);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public ModelsMap postProcessModels(ModelsMap objs) {
|
||||
// process enum in models
|
||||
@@ -1030,15 +1135,18 @@ public abstract class AbstractTypeScriptClientCodegen extends DefaultCodegen imp
|
||||
for (ModelMap mo : models) {
|
||||
CodegenModel cm = mo.getModel();
|
||||
cm.imports = new TreeSet<>(cm.imports);
|
||||
|
||||
// name enum with model name, e.g. StatusEnum => Pet.StatusEnum
|
||||
// This applies to both direct enum properties (isEnum) and properties containing
|
||||
// inner enums (isInnerEnum) like maps or arrays of enums.
|
||||
for (CodegenProperty var : cm.vars) {
|
||||
if (Boolean.TRUE.equals(var.isEnum)) {
|
||||
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
|
||||
var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, cm.classname + classEnumSeparator + var.enumName);
|
||||
}
|
||||
}
|
||||
if (cm.parent != null) {
|
||||
for (CodegenProperty var : cm.allVars) {
|
||||
if (Boolean.TRUE.equals(var.isEnum)) {
|
||||
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
|
||||
var.datatypeWithEnum = var.datatypeWithEnum
|
||||
.replace(var.enumName, cm.classname + classEnumSeparator + var.enumName);
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -72,7 +72,7 @@ public class JavaCamelServerCodegen extends SpringCodegen implements BeanValidat
|
||||
templateDir = "java-camel-server";
|
||||
addCliOptions();
|
||||
artifactId = "openapi-camel";
|
||||
super.library = "";
|
||||
annotationLibrary = AnnotationLibrary.SWAGGER2;
|
||||
}
|
||||
|
||||
@Override
|
||||
|
||||
@@ -25,6 +25,7 @@ import org.openapitools.codegen.*;
|
||||
import org.openapitools.codegen.languages.features.BeanValidationFeatures;
|
||||
import org.openapitools.codegen.meta.features.*;
|
||||
import org.openapitools.codegen.model.ModelMap;
|
||||
import org.openapitools.codegen.model.ModelsMap;
|
||||
import org.openapitools.codegen.model.OperationMap;
|
||||
import org.openapitools.codegen.model.OperationsMap;
|
||||
import org.openapitools.codegen.templating.mustache.CamelCaseLambda;
|
||||
@@ -68,6 +69,9 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
private boolean returnResponse = false;
|
||||
@Setter
|
||||
private boolean omitGradleWrapper = false;
|
||||
@Getter
|
||||
@Setter
|
||||
private boolean fixJacksonJsonTypeInfoInheritance = true;
|
||||
|
||||
// This is here to potentially warn the user when an option is not supported by the target framework.
|
||||
private Map<String, List<String>> optionsSupportedPerFramework = new ImmutableMap.Builder<String, List<String>>()
|
||||
@@ -106,6 +110,9 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
public KotlinServerCodegen() {
|
||||
super();
|
||||
|
||||
// Enable proper oneOf/anyOf discriminator handling for polymorphism
|
||||
legacyDiscriminatorBehavior = false;
|
||||
|
||||
modifyFeatureSet(features -> features
|
||||
.includeDocumentationFeatures(DocumentationFeature.Readme)
|
||||
.wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.XML))
|
||||
@@ -120,7 +127,9 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
GlobalFeature.LinkObjects,
|
||||
GlobalFeature.ParameterStyling
|
||||
)
|
||||
.excludeSchemaSupportFeatures(
|
||||
.includeSchemaSupportFeatures(
|
||||
SchemaSupportFeature.allOf,
|
||||
SchemaSupportFeature.oneOf,
|
||||
SchemaSupportFeature.Polymorphism
|
||||
)
|
||||
.excludeParameterFeatures(
|
||||
@@ -166,6 +175,7 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
addSwitch(Constants.RETURN_RESPONSE, Constants.RETURN_RESPONSE_DESC, returnResponse);
|
||||
addSwitch(Constants.OMIT_GRADLE_WRAPPER, Constants.OMIT_GRADLE_WRAPPER_DESC, omitGradleWrapper);
|
||||
addSwitch(USE_JAKARTA_EE, Constants.USE_JAKARTA_EE_DESC, useJakartaEe);
|
||||
addSwitch(Constants.FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE, Constants.FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE_DESC, fixJacksonJsonTypeInfoInheritance);
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -235,6 +245,11 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
setOmitGradleWrapper(Boolean.parseBoolean(additionalProperties.get(Constants.OMIT_GRADLE_WRAPPER).toString()));
|
||||
}
|
||||
|
||||
if (additionalProperties.containsKey(Constants.FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE)) {
|
||||
setFixJacksonJsonTypeInfoInheritance(Boolean.parseBoolean(additionalProperties.get(Constants.FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE).toString()));
|
||||
}
|
||||
additionalProperties.put(Constants.FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE, fixJacksonJsonTypeInfoInheritance);
|
||||
|
||||
writePropertyBack(USE_BEANVALIDATION, useBeanValidation);
|
||||
|
||||
// set default library to "ktor"
|
||||
@@ -381,6 +396,291 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
public static final String OMIT_GRADLE_WRAPPER = "omitGradleWrapper";
|
||||
public static final String OMIT_GRADLE_WRAPPER_DESC = "Whether to omit Gradle wrapper for creating a sub project.";
|
||||
public static final String IS_KTOR = "isKtor";
|
||||
public static final String FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE = "fixJacksonJsonTypeInfoInheritance";
|
||||
public static final String FIX_JACKSON_JSON_TYPE_INFO_INHERITANCE_DESC = "When true (default), ensures Jackson polymorphism works correctly by: (1) always setting visible=true on @JsonTypeInfo, and (2) adding the discriminator property to child models with appropriate default values. When false, visible is only set to true if all children already define the discriminator property.";
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, ModelsMap> postProcessAllModels(Map<String, ModelsMap> objs) {
|
||||
objs = super.postProcessAllModels(objs);
|
||||
|
||||
// For libraries that use Jackson, set up parent-child relationships for discriminator children
|
||||
// This enables proper polymorphism support with @JsonTypeInfo and @JsonSubTypes annotations
|
||||
if (usesJacksonSerialization()) {
|
||||
// Build a map of model name -> model for easy lookup
|
||||
Map<String, CodegenModel> allModelsMap = new HashMap<>();
|
||||
for (ModelsMap modelsMap : objs.values()) {
|
||||
for (ModelMap modelMap : modelsMap.getModels()) {
|
||||
CodegenModel model = modelMap.getModel();
|
||||
allModelsMap.put(model.getClassname(), model);
|
||||
}
|
||||
}
|
||||
|
||||
// First pass: collect all discriminator parent -> children mappings
|
||||
// Also identify the "true" discriminator owners (not inherited via allOf)
|
||||
Map<String, String> childToParentMap = new HashMap<>();
|
||||
Set<String> trueDiscriminatorOwners = new HashSet<>();
|
||||
|
||||
for (ModelsMap modelsMap : objs.values()) {
|
||||
for (ModelMap modelMap : modelsMap.getModels()) {
|
||||
CodegenModel model = modelMap.getModel();
|
||||
if (model.getDiscriminator() != null && model.getDiscriminator().getMappedModels() != null
|
||||
&& !model.getDiscriminator().getMappedModels().isEmpty()) {
|
||||
String discriminatorPropBaseName = model.getDiscriminator().getPropertyBaseName();
|
||||
|
||||
for (CodegenDiscriminator.MappedModel mappedModel : model.getDiscriminator().getMappedModels()) {
|
||||
childToParentMap.put(mappedModel.getModelName(), model.getClassname());
|
||||
|
||||
// If the mapping name equals the model name, check if we can derive
|
||||
// a better mapping name from the child's discriminator property enum value
|
||||
if (mappedModel.getMappingName().equals(mappedModel.getModelName())) {
|
||||
CodegenModel childModel = allModelsMap.get(mappedModel.getModelName());
|
||||
if (childModel != null) {
|
||||
// Find the discriminator property in the child model
|
||||
for (CodegenProperty prop : childModel.getAllVars()) {
|
||||
if (prop.getBaseName().equals(discriminatorPropBaseName) && prop.isEnum) {
|
||||
// If it's an enum with exactly one value, use that as the mapping name
|
||||
Map<String, Object> allowableValues = prop.getAllowableValues();
|
||||
if (allowableValues != null && allowableValues.containsKey("values")) {
|
||||
@SuppressWarnings("unchecked")
|
||||
List<Object> values = (List<Object>) allowableValues.get("values");
|
||||
if (values != null && values.size() == 1) {
|
||||
mappedModel.setMappingName(String.valueOf(values.get(0)));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// This model owns its discriminator (has mapped models)
|
||||
trueDiscriminatorOwners.add(model.getClassname());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Second pass: process child models
|
||||
for (ModelsMap modelsMap : objs.values()) {
|
||||
for (ModelMap modelMap : modelsMap.getModels()) {
|
||||
CodegenModel model = modelMap.getModel();
|
||||
String parentName = childToParentMap.get(model.getClassname());
|
||||
|
||||
if (parentName != null) {
|
||||
// This model is a child of a discriminator parent
|
||||
CodegenModel parentModel = allModelsMap.get(parentName);
|
||||
|
||||
// Set parent if not already set
|
||||
if (model.getParent() == null) {
|
||||
model.setParent(parentName);
|
||||
}
|
||||
|
||||
// If this child has a discriminator but it's inherited (not a true owner),
|
||||
// remove it - only the parent should have the discriminator annotations
|
||||
if (model.getDiscriminator() != null && !trueDiscriminatorOwners.contains(model.getClassname())) {
|
||||
model.setDiscriminator(null);
|
||||
}
|
||||
|
||||
// For allOf pattern: if parent has properties, mark child's inherited properties
|
||||
// Skip this for oneOf/anyOf patterns where parent properties are merged from children
|
||||
boolean parentIsOneOfOrAnyOf = parentModel != null
|
||||
&& ((parentModel.oneOf != null && !parentModel.oneOf.isEmpty())
|
||||
|| (parentModel.anyOf != null && !parentModel.anyOf.isEmpty()));
|
||||
|
||||
if (parentModel != null && parentModel.getHasVars() && !parentIsOneOfOrAnyOf) {
|
||||
Set<String> parentPropNames = new HashSet<>();
|
||||
List<String> inheritedPropNamesList = new ArrayList<>();
|
||||
for (CodegenProperty parentProp : parentModel.getAllVars()) {
|
||||
parentPropNames.add(parentProp.getBaseName());
|
||||
inheritedPropNamesList.add(parentProp.getName());
|
||||
}
|
||||
|
||||
// Mark properties inherited from parent
|
||||
for (CodegenProperty prop : model.getAllVars()) {
|
||||
if (parentPropNames.contains(prop.getBaseName())) {
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
for (CodegenProperty prop : model.getVars()) {
|
||||
if (parentPropNames.contains(prop.getBaseName())) {
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
for (CodegenProperty prop : model.getRequiredVars()) {
|
||||
if (parentPropNames.contains(prop.getBaseName())) {
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
for (CodegenProperty prop : model.getOptionalVars()) {
|
||||
if (parentPropNames.contains(prop.getBaseName())) {
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
|
||||
// Set vendor extension for parent constructor call with inherited properties
|
||||
if (!inheritedPropNamesList.isEmpty()) {
|
||||
String parentCtorArgs = String.join(", ", inheritedPropNamesList.stream()
|
||||
.map(name -> name + " = " + name)
|
||||
.toArray(String[]::new));
|
||||
model.getVendorExtensions().put("x-parent-ctor-args", parentCtorArgs);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Third pass: set vendor extension for discriminator style and handle fixJacksonJsonTypeInfoInheritance
|
||||
for (String ownerName : trueDiscriminatorOwners) {
|
||||
CodegenModel owner = allModelsMap.get(ownerName);
|
||||
if (owner != null && owner.getDiscriminator() != null) {
|
||||
String discriminatorPropBaseName = owner.getDiscriminator().getPropertyBaseName();
|
||||
boolean isOneOfOrAnyOfPattern = (owner.oneOf != null && !owner.oneOf.isEmpty())
|
||||
|| (owner.anyOf != null && !owner.anyOf.isEmpty());
|
||||
|
||||
// hasParentProperties controls whether the sealed class has properties in its constructor
|
||||
// This should be false for oneOf/anyOf patterns (parent is a type union, no direct properties)
|
||||
// and true for allOf patterns (parent has properties that children inherit)
|
||||
boolean hasParentProperties = !isOneOfOrAnyOfPattern;
|
||||
|
||||
// visibleTrue controls whether visible=true is set on @JsonTypeInfo
|
||||
// When fixJacksonJsonTypeInfoInheritance is true, we always set visible=true
|
||||
// When false, we only set visible=true if the parent has properties (allOf pattern)
|
||||
boolean visibleTrue;
|
||||
|
||||
if (fixJacksonJsonTypeInfoInheritance) {
|
||||
// When fixJacksonJsonTypeInfoInheritance is true:
|
||||
// 1. Always set visible=true so Jackson can read the discriminator
|
||||
// 2. For oneOf/anyOf patterns: add discriminator property to parent and children
|
||||
visibleTrue = true;
|
||||
|
||||
// For oneOf/anyOf patterns, add the discriminator property to the parent sealed class
|
||||
// This allows accessing the discriminator value from the parent type directly
|
||||
if (isOneOfOrAnyOfPattern) {
|
||||
String discriminatorVarName = toVarName(discriminatorPropBaseName);
|
||||
|
||||
// Clear all merged properties from the oneOf parent - they belong to children only
|
||||
// We'll add back just the discriminator property
|
||||
owner.getVars().clear();
|
||||
owner.getRequiredVars().clear();
|
||||
owner.getOptionalVars().clear();
|
||||
owner.getAllVars().clear();
|
||||
|
||||
// Add discriminator property to parent
|
||||
CodegenProperty parentDiscriminatorProp = new CodegenProperty();
|
||||
parentDiscriminatorProp.baseName = discriminatorPropBaseName;
|
||||
parentDiscriminatorProp.name = discriminatorVarName;
|
||||
parentDiscriminatorProp.dataType = "kotlin.String";
|
||||
parentDiscriminatorProp.datatypeWithEnum = "kotlin.String";
|
||||
parentDiscriminatorProp.required = true;
|
||||
parentDiscriminatorProp.isNullable = false;
|
||||
parentDiscriminatorProp.isReadOnly = false;
|
||||
|
||||
owner.getVars().add(parentDiscriminatorProp);
|
||||
owner.getRequiredVars().add(parentDiscriminatorProp);
|
||||
owner.getAllVars().add(parentDiscriminatorProp);
|
||||
|
||||
// Parent now has properties (just the discriminator)
|
||||
hasParentProperties = true;
|
||||
|
||||
// Process children: mark discriminator as inherited and set default values
|
||||
for (CodegenDiscriminator.MappedModel mappedModel : owner.getDiscriminator().getMappedModels()) {
|
||||
CodegenModel childModel = allModelsMap.get(mappedModel.getModelName());
|
||||
if (childModel != null) {
|
||||
boolean hasDiscriminatorProp = false;
|
||||
String discriminatorDefault = "\"" + mappedModel.getMappingName() + "\"";
|
||||
|
||||
// Update existing discriminator property in all lists - mark as inherited
|
||||
for (CodegenProperty prop : childModel.getVars()) {
|
||||
if (prop.getBaseName().equals(discriminatorPropBaseName)) {
|
||||
hasDiscriminatorProp = true;
|
||||
prop.defaultValue = discriminatorDefault;
|
||||
prop.dataType = "kotlin.String";
|
||||
prop.datatypeWithEnum = "kotlin.String";
|
||||
prop.required = true;
|
||||
prop.isNullable = false;
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
for (CodegenProperty prop : childModel.getAllVars()) {
|
||||
if (prop.getBaseName().equals(discriminatorPropBaseName)) {
|
||||
prop.defaultValue = discriminatorDefault;
|
||||
prop.dataType = "kotlin.String";
|
||||
prop.datatypeWithEnum = "kotlin.String";
|
||||
prop.required = true;
|
||||
prop.isNullable = false;
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
|
||||
// Move discriminator from optionalVars to requiredVars if needed
|
||||
CodegenProperty propToMove = null;
|
||||
for (CodegenProperty prop : childModel.getOptionalVars()) {
|
||||
if (prop.getBaseName().equals(discriminatorPropBaseName)) {
|
||||
prop.defaultValue = discriminatorDefault;
|
||||
prop.dataType = "kotlin.String";
|
||||
prop.datatypeWithEnum = "kotlin.String";
|
||||
prop.required = true;
|
||||
prop.isNullable = false;
|
||||
prop.isInherited = true;
|
||||
propToMove = prop;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (propToMove != null) {
|
||||
childModel.getOptionalVars().remove(propToMove);
|
||||
childModel.getRequiredVars().add(propToMove);
|
||||
}
|
||||
|
||||
// Also update if it's already in requiredVars
|
||||
for (CodegenProperty prop : childModel.getRequiredVars()) {
|
||||
if (prop.getBaseName().equals(discriminatorPropBaseName)) {
|
||||
prop.defaultValue = discriminatorDefault;
|
||||
prop.dataType = "kotlin.String";
|
||||
prop.datatypeWithEnum = "kotlin.String";
|
||||
prop.isNullable = false;
|
||||
prop.isInherited = true;
|
||||
}
|
||||
}
|
||||
|
||||
// If child doesn't have the discriminator property, add it as required and inherited
|
||||
if (!hasDiscriminatorProp) {
|
||||
CodegenProperty discriminatorProp = new CodegenProperty();
|
||||
discriminatorProp.baseName = discriminatorPropBaseName;
|
||||
discriminatorProp.name = discriminatorVarName;
|
||||
discriminatorProp.dataType = "kotlin.String";
|
||||
discriminatorProp.datatypeWithEnum = "kotlin.String";
|
||||
discriminatorProp.defaultValue = discriminatorDefault;
|
||||
discriminatorProp.required = true;
|
||||
discriminatorProp.isNullable = false;
|
||||
discriminatorProp.isReadOnly = false;
|
||||
discriminatorProp.isInherited = true;
|
||||
|
||||
childModel.getVars().add(discriminatorProp);
|
||||
childModel.getRequiredVars().add(discriminatorProp);
|
||||
childModel.getAllVars().add(discriminatorProp);
|
||||
}
|
||||
|
||||
// Set parent constructor args for the discriminator property
|
||||
childModel.getVendorExtensions().put("x-parent-ctor-args",
|
||||
discriminatorVarName + " = " + discriminatorVarName);
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// When fixJacksonJsonTypeInfoInheritance is false:
|
||||
// visible=true only for allOf pattern (parent has properties)
|
||||
visibleTrue = hasParentProperties;
|
||||
}
|
||||
|
||||
// Set on both model and discriminator so it's accessible in different template contexts
|
||||
owner.getVendorExtensions().put("x-discriminator-has-parent-properties", hasParentProperties);
|
||||
owner.getDiscriminator().getVendorExtensions().put("x-discriminator-has-parent-properties", hasParentProperties);
|
||||
owner.getVendorExtensions().put("x-discriminator-visible-true", visibleTrue);
|
||||
owner.getDiscriminator().getVendorExtensions().put("x-discriminator-visible-true", visibleTrue);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return objs;
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -462,6 +762,16 @@ public class KotlinServerCodegen extends AbstractKotlinCodegen implements BeanVa
|
||||
return Constants.JAVALIN5.equals(library) || Constants.JAVALIN6.equals(library);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the current library uses Jackson for JSON serialization.
|
||||
* This is used to determine if Jackson-specific features like polymorphism annotations should be enabled.
|
||||
*/
|
||||
private boolean usesJacksonSerialization() {
|
||||
return Constants.JAVALIN5.equals(library) ||
|
||||
Constants.JAVALIN6.equals(library) ||
|
||||
Constants.JAXRS_SPEC.equals(library);
|
||||
}
|
||||
|
||||
private boolean isKtor2Or3() {
|
||||
return Constants.KTOR.equals(library) || Constants.KTOR2.equals(library);
|
||||
}
|
||||
|
||||
@@ -45,6 +45,7 @@ import java.io.Writer;
|
||||
import java.net.URL;
|
||||
import java.util.*;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
|
||||
import static org.openapitools.codegen.utils.StringUtils.camelize;
|
||||
@@ -95,6 +96,7 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
public static final String REQUEST_MAPPING_OPTION = "requestMappingMode";
|
||||
public static final String USE_REQUEST_MAPPING_ON_CONTROLLER = "useRequestMappingOnController";
|
||||
public static final String USE_REQUEST_MAPPING_ON_INTERFACE = "useRequestMappingOnInterface";
|
||||
public static final String AUTO_X_SPRING_PAGINATED = "autoXSpringPaginated";
|
||||
|
||||
@Getter
|
||||
public enum DeclarativeInterfaceReactiveMode {
|
||||
@@ -158,6 +160,7 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
@Setter private boolean beanQualifiers = false;
|
||||
@Setter private DeclarativeInterfaceReactiveMode declarativeInterfaceReactiveMode = DeclarativeInterfaceReactiveMode.coroutines;
|
||||
@Setter private boolean useResponseEntity = true;
|
||||
@Setter private boolean autoXSpringPaginated = false;
|
||||
|
||||
@Getter @Setter
|
||||
protected boolean useSpringBoot3 = false;
|
||||
@@ -247,6 +250,11 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
addSwitch(USE_RESPONSE_ENTITY,
|
||||
"Whether (when false) to return actual type (e.g. List<Fruit>) and handle non-happy path responses via exceptions flow or (when true) return entire ResponseEntity (e.g. ResponseEntity<List<Fruit>>). If disabled, method are annotated using a @ResponseStatus annotation, which has the status of the first response declared in the Api definition",
|
||||
useResponseEntity);
|
||||
addOption(X_KOTLIN_IMPLEMENTS_SKIP, "A list of fully qualified interfaces that should NOT be implemented despite their presence in vendor extension `x-kotlin-implements`. Example: yaml `xKotlinImplementsSkip: [com.some.pack.WithPhotoUrls]` skips implementing the interface in any schema", "empty list");
|
||||
addOption(X_KOTLIN_IMPLEMENTS_FIELDS_SKIP, "A list of fields per schema name that should NOT be created with `override` keyword despite their presence in vendor extension `x-kotlin-implements-fields` for the schema. Example: yaml `xKotlinImplementsFieldsSkip: Pet: [photoUrls]` skips `override` for `photoUrls` in schema `Pet`", "empty map");
|
||||
addOption(SCHEMA_IMPLEMENTS, "A map of single interface or a list of interfaces per schema name that should be implemented (serves similar purpose as `x-kotlin-implements`, but is fully decoupled from the api spec). Example: yaml `schemaImplements: {Pet: com.some.pack.WithId, Category: [com.some.pack.CategoryInterface], Dog: [com.some.pack.Canine, com.some.pack.OtherInterface]}` implements interfaces in schemas `Pet` (interface `com.some.pack.WithId`), `Category` (interface `com.some.pack.CategoryInterface`), `Dog`(interfaces `com.some.pack.Canine`, `com.some.pack.OtherInterface`)", "empty map");
|
||||
addOption(SCHEMA_IMPLEMENTS_FIELDS, "A map of single field or a list of fields per schema name that should be prepended with `override` (serves similar purpose as `x-kotlin-implements-fields`, but is fully decoupled from the api spec). Example: yaml `schemaImplementsFields: {Pet: id, Category: [name, id], Dog: [bark, breed]}` marks fields to be prepended with `override` in schemas `Pet` (field `id`), `Category` (fields `name`, `id`) and `Dog` (fields `bark`, `breed`)", "empty map");
|
||||
addSwitch(AUTO_X_SPRING_PAGINATED, "Automatically add x-spring-paginated to operations that have 'page', 'size', and 'sort' query parameters. When enabled, operations with all three parameters will have Pageable support automatically applied. Operations with x-spring-paginated explicitly set to false will not be auto-detected.", autoXSpringPaginated);
|
||||
supportedLibraries.put(SPRING_BOOT, "Spring-boot Server application.");
|
||||
supportedLibraries.put(SPRING_CLOUD_LIBRARY,
|
||||
"Spring-Cloud-Feign client with Spring-Boot auto-configured settings.");
|
||||
@@ -443,6 +451,12 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
additionalProperties.put(DOCUMENTATION_PROVIDER, DocumentationProvider.NONE);
|
||||
additionalProperties.put(ANNOTATION_LIBRARY, AnnotationLibrary.NONE);
|
||||
}
|
||||
if (additionalProperties.containsKey(USE_SPRING_BOOT3)) {
|
||||
this.setUseSpringBoot3(convertPropertyToBoolean(USE_SPRING_BOOT3));
|
||||
}
|
||||
if (additionalProperties.containsKey(INCLUDE_HTTP_REQUEST_CONTEXT)) {
|
||||
this.setIncludeHttpRequestContext(convertPropertyToBoolean(INCLUDE_HTTP_REQUEST_CONTEXT));
|
||||
}
|
||||
|
||||
if (isModelMutable()) {
|
||||
typeMapping.put("array", "kotlin.collections.MutableList");
|
||||
@@ -466,6 +480,14 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
// used later in recursive import in postProcessingModels
|
||||
importMapping.put("com.fasterxml.jackson.annotation.JsonProperty", "com.fasterxml.jackson.annotation.JsonCreator");
|
||||
|
||||
// Spring-specific import mappings for x-spring-paginated support
|
||||
importMapping.put("ApiIgnore", "springfox.documentation.annotations.ApiIgnore");
|
||||
importMapping.put("ParameterObject", "org.springdoc.api.annotations.ParameterObject");
|
||||
importMapping.put("PageableAsQueryParam", "org.springdoc.core.converters.models.PageableAsQueryParam");
|
||||
if (useSpringBoot3) {
|
||||
importMapping.put("ParameterObject", "org.springdoc.core.annotations.ParameterObject");
|
||||
}
|
||||
|
||||
if (!additionalProperties.containsKey(CodegenConstants.LIBRARY)) {
|
||||
additionalProperties.put(CodegenConstants.LIBRARY, library);
|
||||
}
|
||||
@@ -638,13 +660,10 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
if (additionalProperties.containsKey(USE_TAGS)) {
|
||||
this.setUseTags(Boolean.parseBoolean(additionalProperties.get(USE_TAGS).toString()));
|
||||
}
|
||||
|
||||
if (additionalProperties.containsKey(USE_SPRING_BOOT3)) {
|
||||
this.setUseSpringBoot3(convertPropertyToBoolean(USE_SPRING_BOOT3));
|
||||
}
|
||||
if (additionalProperties.containsKey(INCLUDE_HTTP_REQUEST_CONTEXT)) {
|
||||
this.setIncludeHttpRequestContext(convertPropertyToBoolean(INCLUDE_HTTP_REQUEST_CONTEXT));
|
||||
if (additionalProperties.containsKey(AUTO_X_SPRING_PAGINATED) && library.equals(SPRING_BOOT)) {
|
||||
this.setAutoXSpringPaginated(convertPropertyToBoolean(AUTO_X_SPRING_PAGINATED));
|
||||
}
|
||||
writePropertyBack(AUTO_X_SPRING_PAGINATED, autoXSpringPaginated);
|
||||
if (isUseSpringBoot3()) {
|
||||
if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
|
||||
throw new IllegalArgumentException(DocumentationProvider.SPRINGFOX.getPropertyName() + " is not supported with Spring Boot > 3.x");
|
||||
@@ -798,7 +817,7 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
gradleWrapperPackage.replace(".", File.separator), "gradle-wrapper.jar"));
|
||||
}
|
||||
|
||||
apiTemplateFiles.put("apiInterface.mustache", "Client.kt");
|
||||
apiTemplateFiles.put("apiInterface.mustache", ".kt");
|
||||
apiTestTemplateFiles.clear();
|
||||
}
|
||||
|
||||
@@ -868,6 +887,108 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes operations to support the x-spring-paginated vendor extension.
|
||||
*
|
||||
* When x-spring-paginated is set to true on an operation, this method:
|
||||
* - Adds org.springframework.data.domain.Pageable parameter to the method signature
|
||||
* - Removes the default Spring Data Web pagination query parameters (page, size, sort)
|
||||
* - Adds appropriate imports (Pageable, ApiIgnore for springfox, ParameterObject for springdoc)
|
||||
*
|
||||
* Auto-detection (when autoXSpringPaginated is enabled):
|
||||
* - Automatically detects operations with 'page', 'size', and 'sort' query parameters (case-sensitive)
|
||||
* - Applies x-spring-paginated behavior to these operations automatically
|
||||
* - Respects manual x-spring-paginated: false setting (manual override takes precedence)
|
||||
* - Only applies when library is spring-boot
|
||||
*
|
||||
* Note: x-spring-paginated is ONLY applied for server-side libraries (spring-boot).
|
||||
* Client libraries (spring-cloud, spring-declarative-http-interface) need actual query parameters
|
||||
* to send over HTTP, so the extension is ignored for them.
|
||||
*
|
||||
* Parameter ordering in generated methods:
|
||||
* 1. Regular OpenAPI parameters (allParams)
|
||||
* 2. Optional HttpServletRequest/ServerWebExchange (if includeHttpRequestContext is enabled)
|
||||
* 3. Pageable parameter (if x-spring-paginated is true and library is spring-boot)
|
||||
*
|
||||
* This implementation mirrors the behavior in SpringCodegen for consistency.
|
||||
*
|
||||
* @param path the operation path
|
||||
* @param httpMethod the HTTP method
|
||||
* @param operation the OpenAPI operation
|
||||
* @param servers the list of servers
|
||||
* @return the processed CodegenOperation
|
||||
*/
|
||||
@Override
|
||||
public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers) {
|
||||
// #8315 Spring Data Web default query params recognized by Pageable
|
||||
List<String> defaultPageableQueryParams = Arrays.asList("page", "size", "sort");
|
||||
|
||||
CodegenOperation codegenOperation = super.fromOperation(path, httpMethod, operation, servers);
|
||||
|
||||
// Check if operation has all three pagination query parameters (case-sensitive)
|
||||
boolean hasParamsForPageable = codegenOperation.queryParams.stream()
|
||||
.map(p -> p.baseName)
|
||||
.collect(Collectors.toSet())
|
||||
.containsAll(defaultPageableQueryParams);
|
||||
// Auto-detect pagination parameters and add x-spring-paginated if autoXSpringPaginated is enabled
|
||||
// Only for spring-boot library, respect manual x-spring-paginated: false setting
|
||||
if (SPRING_BOOT.equals(library) && autoXSpringPaginated) {
|
||||
// Check if x-spring-paginated is not explicitly set to false
|
||||
if (operation.getExtensions() == null || !Boolean.FALSE.equals(operation.getExtensions().get("x-spring-paginated"))) {
|
||||
|
||||
|
||||
if (hasParamsForPageable) {
|
||||
// Automatically add x-spring-paginated to the operation
|
||||
if (operation.getExtensions() == null) {
|
||||
operation.setExtensions(new HashMap<>());
|
||||
}
|
||||
operation.getExtensions().put("x-spring-paginated", Boolean.TRUE);
|
||||
codegenOperation.vendorExtensions.put("x-spring-paginated", Boolean.TRUE);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Only process x-spring-paginated for server-side libraries (spring-boot)
|
||||
// Client libraries (spring-cloud, spring-declarative-http-interface) need actual query parameters for HTTP requests
|
||||
if (SPRING_BOOT.equals(library)) {
|
||||
// add Pageable import only if x-spring-paginated explicitly used AND it's a server library
|
||||
// this allows to use a custom Pageable schema without importing Spring Pageable.
|
||||
if (operation.getExtensions() != null && Boolean.TRUE.equals(operation.getExtensions().get("x-spring-paginated"))) {
|
||||
importMapping.putIfAbsent("Pageable", "org.springframework.data.domain.Pageable");
|
||||
}
|
||||
|
||||
// add org.springframework.data.domain.Pageable import when needed (server libraries only)
|
||||
if (operation.getExtensions() != null && Boolean.TRUE.equals(operation.getExtensions().get("x-spring-paginated"))) {
|
||||
codegenOperation.imports.add("Pageable");
|
||||
if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
|
||||
codegenOperation.imports.add("ApiIgnore");
|
||||
}
|
||||
if (DocumentationProvider.SPRINGDOC.equals(getDocumentationProvider())) {
|
||||
codegenOperation.imports.add("PageableAsQueryParam");
|
||||
// Prepend @PageableAsQueryParam to existing x-operation-extra-annotation if present
|
||||
// Use getObjectAsStringList to properly handle both list and string formats:
|
||||
// - YAML list: ['@Ann1', '@Ann2'] -> List of annotations
|
||||
// - Single string: '@Ann1 @Ann2' -> Single-element list
|
||||
// - Nothing/null -> Empty list
|
||||
Object existingAnnotation = codegenOperation.vendorExtensions.get("x-operation-extra-annotation");
|
||||
List<String> annotations = DefaultCodegen.getObjectAsStringList(existingAnnotation);
|
||||
|
||||
// Prepend @PageableAsQueryParam to the beginning of the list
|
||||
List<String> updatedAnnotations = new ArrayList<>();
|
||||
updatedAnnotations.add("@PageableAsQueryParam");
|
||||
updatedAnnotations.addAll(annotations);
|
||||
|
||||
codegenOperation.vendorExtensions.put("x-operation-extra-annotation", updatedAnnotations);
|
||||
}
|
||||
|
||||
// #8315 Remove matching Spring Data Web default query params if 'x-spring-paginated' with Pageable is used
|
||||
codegenOperation.queryParams.removeIf(param -> defaultPageableQueryParams.contains(param.baseName));
|
||||
codegenOperation.allParams.removeIf(param -> param.isQueryParam && defaultPageableQueryParams.contains(param.baseName));
|
||||
}
|
||||
}
|
||||
return codegenOperation;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void preprocessOpenAPI(OpenAPI openAPI) {
|
||||
super.preprocessOpenAPI(openAPI);
|
||||
@@ -1113,12 +1234,14 @@ public class KotlinSpringServerCodegen extends AbstractKotlinCodegen
|
||||
extensions.add(VendorExtension.X_CONTENT_TYPE);
|
||||
extensions.add(VendorExtension.X_DISCRIMINATOR_VALUE);
|
||||
extensions.add(VendorExtension.X_FIELD_EXTRA_ANNOTATION);
|
||||
extensions.add(VendorExtension.X_OPERATION_EXTRA_ANNOTATION);
|
||||
extensions.add(VendorExtension.X_PATTERN_MESSAGE);
|
||||
extensions.add(VendorExtension.X_SIZE_MESSAGE);
|
||||
extensions.add(VendorExtension.X_MINIMUM_MESSAGE);
|
||||
extensions.add(VendorExtension.X_MAXIMUM_MESSAGE);
|
||||
extensions.add(VendorExtension.X_KOTLIN_IMPLEMENTS);
|
||||
extensions.add(VendorExtension.X_KOTLIN_IMPLEMENTS_FIELDS);
|
||||
extensions.add(VendorExtension.X_SPRING_PAGINATED);
|
||||
return extensions;
|
||||
}
|
||||
|
||||
|
||||
@@ -386,7 +386,7 @@ public class RustServerCodegen extends AbstractRustCodegen implements CodegenCon
|
||||
|
||||
@Override
|
||||
public String toEnumValue(String value, String datatype) {
|
||||
// rust-server templates expect value to be in quotes
|
||||
// rust-server templates expect value to be in quotes for Display/FromStr
|
||||
return "\"" + super.toEnumValue(value, datatype) + "\"";
|
||||
}
|
||||
|
||||
@@ -977,7 +977,6 @@ public class RustServerCodegen extends AbstractRustCodegen implements CodegenCon
|
||||
|
||||
for (CodegenSecurity s : op.authMethods) {
|
||||
if (s.isApiKey && s.isKeyInHeader) {
|
||||
s.vendorExtensions.put("x-api-key-name", toModelName(s.keyParamName));
|
||||
headerAuthMethods = true;
|
||||
}
|
||||
|
||||
@@ -1565,6 +1564,58 @@ public class RustServerCodegen extends AbstractRustCodegen implements CodegenCon
|
||||
public ModelsMap postProcessModels(ModelsMap objs) {
|
||||
ModelsMap result = super.postProcessModelsEnum(objs);
|
||||
|
||||
// Detect integer enums and mark them for serde_repr usage
|
||||
for (ModelMap modelMap : result.getModels()) {
|
||||
CodegenModel model = modelMap.getModel();
|
||||
|
||||
if (Boolean.TRUE.equals(model.isEnum) &&
|
||||
(model.isInteger || model.isLong || model.isNumber) &&
|
||||
model.allowableValues != null) {
|
||||
|
||||
// Determine the correct Rust type for the enum's repr
|
||||
String rustType;
|
||||
if (model.isNumber && !model.isInteger && !model.isLong) {
|
||||
// Floating point enum - use dataType or default to f64
|
||||
rustType = "f32".equals(model.dataType) ? "f32" : "f64";
|
||||
} else {
|
||||
// Integer enum - apply the same type fitting logic as properties
|
||||
rustType = applyIntegerTypeFitting(
|
||||
model.getFormat(),
|
||||
model.getMinimum(),
|
||||
model.getMaximum(),
|
||||
model.getExclusiveMinimum(),
|
||||
model.getExclusiveMaximum());
|
||||
// If applyIntegerTypeFitting returns null, default to i32
|
||||
if (rustType == null) {
|
||||
rustType = "i32";
|
||||
}
|
||||
}
|
||||
|
||||
// Mark this as an integer enum and store the Rust type
|
||||
model.vendorExtensions.put("x-is-integer-enum", true);
|
||||
model.vendorExtensions.put("x-rust-type", rustType);
|
||||
|
||||
// Set global flag to include serde_repr dependency
|
||||
additionalProperties.put("apiUsesIntegerEnums", true);
|
||||
|
||||
// Add numeric discriminant values for enum variants
|
||||
@SuppressWarnings("unchecked")
|
||||
List<Map<String, Object>> enumVars =
|
||||
(List<Map<String, Object>>) model.allowableValues.get("enumVars");
|
||||
|
||||
if (enumVars != null) {
|
||||
for (Map<String, Object> enumVar : enumVars) {
|
||||
String value = (String) enumVar.get("value");
|
||||
if (value != null) {
|
||||
// Strip quotes to get raw numeric value
|
||||
String numericValue = value.substring(1, value.length() - 1);
|
||||
enumVar.put("numericDiscriminant", numericValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check for model names that conflict with serde_valid macro internals
|
||||
// Once we find one, set a class-level flag that persists across all model batches
|
||||
if (!hasConflictingModelNames) {
|
||||
|
||||
@@ -93,6 +93,7 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
public static final String GENERATE_GENERIC_RESPONSE_ENTITY = "generateGenericResponseEntity";
|
||||
public static final String USE_ENUM_CASE_INSENSITIVE = "useEnumCaseInsensitive";
|
||||
public static final String USE_SPRING_BOOT3 = "useSpringBoot3";
|
||||
public static final String USE_SPRING_BOOT4 = "useSpringBoot4";
|
||||
public static final String REQUEST_MAPPING_OPTION = "requestMappingMode";
|
||||
public static final String USE_REQUEST_MAPPING_ON_CONTROLLER = "useRequestMappingOnController";
|
||||
public static final String USE_REQUEST_MAPPING_ON_INTERFACE = "useRequestMappingOnInterface";
|
||||
@@ -101,6 +102,10 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
public static final String USE_SPRING_BUILT_IN_VALIDATION = "useSpringBuiltInValidation";
|
||||
public static final String USE_DEDUCTION_FOR_ONE_OF_INTERFACES = "useDeductionForOneOfInterfaces";
|
||||
public static final String SPRING_API_VERSION = "springApiVersion";
|
||||
public static final String USE_JACKSON_3 = "useJackson3";
|
||||
public static final String JACKSON2_PACKAGE = "com.fasterxml.jackson";
|
||||
public static final String JACKSON3_PACKAGE = "tools.jackson";
|
||||
public static final String JACKSON_PACKAGE = "jacksonPackage";
|
||||
|
||||
@Getter
|
||||
public enum RequestMappingMode {
|
||||
@@ -154,6 +159,8 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
@Setter protected boolean useEnumCaseInsensitive = false;
|
||||
@Getter @Setter
|
||||
protected boolean useSpringBoot3 = false;
|
||||
@Getter @Setter
|
||||
protected boolean useSpringBoot4 = false;
|
||||
protected boolean generatedConstructorWithRequiredArgs = true;
|
||||
@Getter @Setter
|
||||
protected RequestMappingMode requestMappingMode = RequestMappingMode.controller;
|
||||
@@ -163,6 +170,8 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
protected boolean useSpringBuiltInValidation = false;
|
||||
@Getter @Setter
|
||||
protected boolean useDeductionForOneOfInterfaces = false;
|
||||
@Getter @Setter
|
||||
protected boolean useJackson3 = false;
|
||||
|
||||
public SpringCodegen() {
|
||||
super();
|
||||
@@ -249,6 +258,9 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
cliOptions
|
||||
.add(CliOption.newBoolean(RETURN_SUCCESS_CODE, "Generated server returns 2xx code", returnSuccessCode));
|
||||
cliOptions.add(CliOption.newBoolean(SPRING_CONTROLLER, "Annotate the generated API as a Spring Controller", useSpringController));
|
||||
cliOptions.add(CliOption.newString(X_IMPLEMENTS_SKIP, "Ability to choose interfaces that should NOT be implemented in the models despite their presence in vendor extension `x-implements`. Takes a list of fully qualified interface names. Example: yaml `xImplementsSkip: [com.some.pack.WithPhotoUrls]` skips implementing the interface `com.some.pack.WithPhotoUrls` in any schema", "empty list"));
|
||||
cliOptions.add(CliOption.newString(SCHEMA_IMPLEMENTS, "Ability to supply interfaces per schema that should be implemented (serves similar purpose as vendor extension `x-implements`, but is fully decoupled from the api spec). Example: yaml `schemaImplements: {Pet: com.some.pack.WithId, Category: [com.some.pack.CategoryInterface], Dog: [com.some.pack.Canine, com.some.pack.OtherInterface]}` implements interfaces in schemas `Pet` (interface `com.some.pack.WithId`), `Category` (interface `com.some.pack.CategoryInterface`), `Dog`(interfaces `com.some.pack.Canine`, `com.some.pack.OtherInterface`)", "empty map"));
|
||||
|
||||
|
||||
CliOption requestMappingOpt = new CliOption(REQUEST_MAPPING_OPTION,
|
||||
"Where to generate the class level @RequestMapping annotation.")
|
||||
@@ -278,6 +290,10 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
cliOptions.add(CliOption.newBoolean(USE_SPRING_BOOT3,
|
||||
"Generate code and provide dependencies for use with Spring Boot ≥ 3 (use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.",
|
||||
useSpringBoot3));
|
||||
cliOptions.add(CliOption.newBoolean(USE_SPRING_BOOT4,
|
||||
"Generate code and provide dependencies for use with Spring Boot 4.x. (Use jakarta instead of javax in imports). Enabling this option will also enable `useJakartaEe`.",
|
||||
useSpringBoot4));
|
||||
cliOptions.add(CliOption.newBoolean(USE_JACKSON_3, "Set it in order to use jackson 3 dependencies (only allowed when `" + USE_SPRING_BOOT4 + "` is set and incompatible with `"+OPENAPI_NULLABLE+"`).", useJackson3));
|
||||
cliOptions.add(CliOption.newBoolean(GENERATE_CONSTRUCTOR_WITH_REQUIRED_ARGS,
|
||||
"Whether to generate constructors with required args for models",
|
||||
generatedConstructorWithRequiredArgs));
|
||||
@@ -460,8 +476,13 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
additionalProperties.put("springHttpStatus", new SpringHttpStatusLambda());
|
||||
|
||||
convertPropertyToBooleanAndWriteBack(USE_ENUM_CASE_INSENSITIVE, this::setUseEnumCaseInsensitive);
|
||||
convertPropertyToBooleanAndWriteBack(USE_JACKSON_3, this::setUseJackson3);
|
||||
convertPropertyToBooleanAndWriteBack(USE_SPRING_BOOT3, this::setUseSpringBoot3);
|
||||
if (isUseSpringBoot3()) {
|
||||
convertPropertyToBooleanAndWriteBack(USE_SPRING_BOOT4, this::setUseSpringBoot4);
|
||||
if(isUseSpringBoot3() && isUseSpringBoot4()){
|
||||
throw new IllegalArgumentException("Choose between Spring Boot 3 and Spring Boot 4");
|
||||
}
|
||||
if (isUseSpringBoot3() || isUseSpringBoot4()) {
|
||||
if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
|
||||
throw new IllegalArgumentException(DocumentationProvider.SPRINGFOX.getPropertyName() + " is not supported with Spring Boot > 3.x");
|
||||
}
|
||||
@@ -471,15 +492,30 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
useJakartaEe = true;
|
||||
applyJakartaPackage();
|
||||
}
|
||||
if(isUseJackson3() && !isUseSpringBoot4()){
|
||||
throw new IllegalArgumentException("useJackson3 is only available with Spring Boot >= 4");
|
||||
}
|
||||
if(isUseJackson3() && isOpenApiNullable()){
|
||||
throw new IllegalArgumentException("openApiNullable cannot be set with useJackson3");
|
||||
}
|
||||
if(this.useJackson3){
|
||||
this.applyJackson3Package();
|
||||
} else {
|
||||
this.applyJackson2Package();
|
||||
}
|
||||
convertPropertyToStringAndWriteBack(RESOURCE_FOLDER, this::setResourceFolder);
|
||||
|
||||
|
||||
// override parent one
|
||||
importMapping.put("JsonDeserialize", (useJackson3 ? JACKSON3_PACKAGE : JACKSON2_PACKAGE) + ".databind.annotation.JsonDeserialize");
|
||||
|
||||
typeMapping.put("file", "org.springframework.core.io.Resource");
|
||||
importMapping.put("Nullable", "org.springframework.lang.Nullable");
|
||||
importMapping.put("org.springframework.core.io.Resource", "org.springframework.core.io.Resource");
|
||||
importMapping.put("DateTimeFormat", "org.springframework.format.annotation.DateTimeFormat");
|
||||
importMapping.put("ApiIgnore", "springfox.documentation.annotations.ApiIgnore");
|
||||
importMapping.put("ParameterObject", "org.springdoc.api.annotations.ParameterObject");
|
||||
if (isUseSpringBoot3()) {
|
||||
if (isUseSpringBoot3() || isUseSpringBoot4()) {
|
||||
importMapping.put("ParameterObject", "org.springdoc.core.annotations.ParameterObject");
|
||||
}
|
||||
|
||||
@@ -488,7 +524,9 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
additionalProperties.put("delegate-method", true);
|
||||
}
|
||||
|
||||
if (isUseSpringBoot3()) {
|
||||
if (isUseSpringBoot4()) {
|
||||
supportingFiles.add(new SupportingFile("pom-sb4.mustache", "", "pom.xml"));
|
||||
} else if (isUseSpringBoot3()) {
|
||||
supportingFiles.add(new SupportingFile("pom-sb3.mustache", "", "pom.xml"));
|
||||
} else {
|
||||
supportingFiles.add(new SupportingFile("pom.mustache", "", "pom.xml"));
|
||||
@@ -654,6 +692,14 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
supportsAdditionalPropertiesWithComposedSchema = true;
|
||||
}
|
||||
|
||||
protected void applyJackson2Package() {
|
||||
writePropertyBack(JACKSON_PACKAGE, JACKSON2_PACKAGE);
|
||||
}
|
||||
|
||||
protected void applyJackson3Package() {
|
||||
writePropertyBack(JACKSON_PACKAGE, JACKSON3_PACKAGE);
|
||||
}
|
||||
|
||||
private boolean supportLibraryUseTags() {
|
||||
return SPRING_BOOT.equals(library) || SPRING_CLOUD_LIBRARY.equals(library);
|
||||
}
|
||||
@@ -968,11 +1014,6 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
if (model.getVendorExtensions().containsKey("x-jackson-optional-nullable-helpers")) {
|
||||
model.imports.add("Arrays");
|
||||
}
|
||||
|
||||
// to prevent inheritors (JavaCamelServerCodegen etc.) mistakenly use it
|
||||
if (getName().contains("spring")) {
|
||||
model.imports.add("Nullable");
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -989,6 +1030,11 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
codegenModel.imports.remove("Schema");
|
||||
}
|
||||
|
||||
// Only add Nullable import for non-enum models that may have nullable fields
|
||||
if (!Boolean.TRUE.equals(codegenModel.isEnum)) {
|
||||
addSpringNullableImport(codegenModel.imports);
|
||||
}
|
||||
|
||||
return codegenModel;
|
||||
}
|
||||
|
||||
@@ -1052,11 +1098,7 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
codegenOperation.imports.addAll(provideArgsClassSet);
|
||||
}
|
||||
|
||||
// to prevent inheritors (JavaCamelServerCodegen etc.) mistakenly use it
|
||||
if (getName().contains("spring")) {
|
||||
codegenOperation.allParams.stream().filter(CodegenParameter::notRequiredOrIsNullable).findAny()
|
||||
.ifPresent(p -> codegenOperation.imports.add("Nullable"));
|
||||
}
|
||||
addSpringNullableImportForOperation(codegenOperation);
|
||||
|
||||
if (reactive) {
|
||||
if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
|
||||
@@ -1219,4 +1261,26 @@ public class SpringCodegen extends AbstractJavaCodegen
|
||||
extensions.add(VendorExtension.X_SPRING_API_VERSION);
|
||||
return extensions;
|
||||
}
|
||||
|
||||
private boolean isSpringCodegen() {
|
||||
return getName().contains("spring");
|
||||
}
|
||||
|
||||
private void addSpringNullableImport(Set<String> imports) {
|
||||
if (isSpringCodegen()) {
|
||||
imports.add("Nullable");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds Spring Nullable import if any parameter is nullable or optional.
|
||||
*/
|
||||
private void addSpringNullableImportForOperation(CodegenOperation codegenOperation) {
|
||||
if (isSpringCodegen()) {
|
||||
codegenOperation.allParams.stream()
|
||||
.filter(CodegenParameter::notRequiredOrIsNullable)
|
||||
.findAny()
|
||||
.ifPresent(param -> codegenOperation.imports.add("Nullable"));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,556 @@
|
||||
/*
|
||||
* Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.openapitools.codegen.languages;
|
||||
|
||||
import org.openapitools.codegen.*;
|
||||
import org.openapitools.codegen.meta.GeneratorMetadata;
|
||||
import org.openapitools.codegen.meta.Stability;
|
||||
import org.openapitools.codegen.meta.features.*;
|
||||
import org.openapitools.codegen.model.ModelMap;
|
||||
import org.openapitools.codegen.model.ModelsMap;
|
||||
import org.openapitools.codegen.model.OperationMap;
|
||||
import org.openapitools.codegen.model.OperationsMap;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.*;
|
||||
|
||||
import static org.openapitools.codegen.utils.StringUtils.camelize;
|
||||
import static org.openapitools.codegen.utils.StringUtils.underscore;
|
||||
|
||||
public class TerraformProviderCodegen extends AbstractGoCodegen {
|
||||
|
||||
private final Logger LOGGER = LoggerFactory.getLogger(TerraformProviderCodegen.class);
|
||||
|
||||
public static final String PROVIDER_NAME = "providerName";
|
||||
public static final String PROVIDER_ADDRESS = "providerAddress";
|
||||
public static final String PROVIDER_VERSION = "providerVersion";
|
||||
|
||||
protected String providerName = "example";
|
||||
protected String providerAddress = "registry.terraform.io/example/example";
|
||||
protected String providerVersion = "0.1.0";
|
||||
|
||||
@Override
|
||||
public CodegenType getTag() {
|
||||
return CodegenType.CLIENT;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return "terraform-provider";
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getHelp() {
|
||||
return "Generates a Terraform provider (Go, using HashiCorp Plugin Framework).";
|
||||
}
|
||||
|
||||
public TerraformProviderCodegen() {
|
||||
super();
|
||||
|
||||
generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
|
||||
.stability(Stability.EXPERIMENTAL)
|
||||
.build();
|
||||
|
||||
modifyFeatureSet(features -> features
|
||||
.includeDocumentationFeatures(DocumentationFeature.Readme)
|
||||
.wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON))
|
||||
.securityFeatures(EnumSet.of(
|
||||
SecurityFeature.BasicAuth,
|
||||
SecurityFeature.BearerToken,
|
||||
SecurityFeature.ApiKey
|
||||
))
|
||||
.excludeGlobalFeatures(
|
||||
GlobalFeature.XMLStructureDefinitions,
|
||||
GlobalFeature.Callbacks,
|
||||
GlobalFeature.LinkObjects,
|
||||
GlobalFeature.ParameterStyling
|
||||
)
|
||||
.excludeSchemaSupportFeatures(
|
||||
SchemaSupportFeature.Polymorphism
|
||||
)
|
||||
);
|
||||
|
||||
outputFolder = "generated-code/terraform-provider";
|
||||
embeddedTemplateDir = templateDir = "terraform-provider";
|
||||
|
||||
// API templates: generate per-tag resource, data source, and model files
|
||||
apiTemplateFiles.put("resource.mustache", "_resource.go");
|
||||
apiTemplateFiles.put("data_source.mustache", "_data_source.go");
|
||||
apiTemplateFiles.put("resource_model.mustache", "_model.go");
|
||||
|
||||
// Model templates: generate per-schema Go structs for the client package
|
||||
modelTemplateFiles.put("model.mustache", ".go");
|
||||
|
||||
// No doc templates
|
||||
apiDocTemplateFiles.clear();
|
||||
modelDocTemplateFiles.clear();
|
||||
|
||||
hideGenerationTimestamp = Boolean.TRUE;
|
||||
|
||||
// Override type mappings for Terraform (no time.Time or *os.File)
|
||||
typeMapping.put("DateTime", "string");
|
||||
typeMapping.put("date", "string");
|
||||
typeMapping.put("File", "string");
|
||||
typeMapping.put("file", "string");
|
||||
typeMapping.put("binary", "string");
|
||||
|
||||
cliOptions.add(new CliOption(PROVIDER_NAME, "Terraform provider name (e.g. 'petstore')")
|
||||
.defaultValue(providerName));
|
||||
cliOptions.add(new CliOption(PROVIDER_ADDRESS, "Terraform provider registry address")
|
||||
.defaultValue(providerAddress));
|
||||
cliOptions.add(new CliOption(PROVIDER_VERSION, "Terraform provider version")
|
||||
.defaultValue(providerVersion));
|
||||
}
|
||||
|
||||
@Override
|
||||
public void processOpts() {
|
||||
super.processOpts();
|
||||
|
||||
if (additionalProperties.containsKey(PROVIDER_NAME)) {
|
||||
providerName = additionalProperties.get(PROVIDER_NAME).toString();
|
||||
}
|
||||
additionalProperties.put(PROVIDER_NAME, providerName);
|
||||
|
||||
if (additionalProperties.containsKey(PROVIDER_ADDRESS)) {
|
||||
providerAddress = additionalProperties.get(PROVIDER_ADDRESS).toString();
|
||||
}
|
||||
additionalProperties.put(PROVIDER_ADDRESS, providerAddress);
|
||||
|
||||
if (additionalProperties.containsKey(PROVIDER_VERSION)) {
|
||||
providerVersion = additionalProperties.get(PROVIDER_VERSION).toString();
|
||||
}
|
||||
additionalProperties.put(PROVIDER_VERSION, providerVersion);
|
||||
|
||||
if (additionalProperties.containsKey(CodegenConstants.PACKAGE_NAME)) {
|
||||
setPackageName((String) additionalProperties.get(CodegenConstants.PACKAGE_NAME));
|
||||
} else {
|
||||
setPackageName("provider");
|
||||
}
|
||||
additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
|
||||
|
||||
apiPackage = "internal" + File.separator + "provider";
|
||||
modelPackage = "internal" + File.separator + "client";
|
||||
|
||||
// Supporting files
|
||||
supportingFiles.add(new SupportingFile("main.mustache", "", "main.go"));
|
||||
supportingFiles.add(new SupportingFile("provider.mustache", "internal" + File.separator + "provider", "provider.go"));
|
||||
supportingFiles.add(new SupportingFile("client.mustache", "internal" + File.separator + "client", "client.go"));
|
||||
supportingFiles.add(new SupportingFile("go.mod.mustache", "", "go.mod"));
|
||||
supportingFiles.add(new SupportingFile("GNUmakefile.mustache", "", "GNUmakefile"));
|
||||
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
|
||||
supportingFiles.add(new SupportingFile("gitignore.mustache", "", ".gitignore"));
|
||||
supportingFiles.add(new SupportingFile("provider_example.mustache", "examples" + File.separator + "provider", "provider.tf"));
|
||||
}
|
||||
|
||||
@Override
|
||||
public String apiFileFolder() {
|
||||
return outputFolder + File.separator + "internal" + File.separator + "provider";
|
||||
}
|
||||
|
||||
@Override
|
||||
public String modelFileFolder() {
|
||||
return outputFolder + File.separator + "internal" + File.separator + "client";
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toApiFilename(String name) {
|
||||
return underscore(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toModelFilename(String name) {
|
||||
return "model_" + underscore(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
|
||||
OperationMap objectMap = objs.getOperations();
|
||||
List<CodegenOperation> operations = objectMap.getOperation();
|
||||
|
||||
// Store original uppercase HTTP method and build fmt.Sprintf-ready paths
|
||||
for (CodegenOperation operation : operations) {
|
||||
// Store uppercase method for net/http (e.g. "POST", "GET")
|
||||
operation.vendorExtensions.put("x-terraform-http-method", operation.httpMethod.toUpperCase(Locale.ROOT));
|
||||
|
||||
// Convert path params to fmt.Sprintf format: /pet/{petId} -> /pet/%v
|
||||
if (operation.path != null && operation.pathParams != null && !operation.pathParams.isEmpty()) {
|
||||
String fmtPath = operation.path;
|
||||
for (CodegenParameter param : operation.pathParams) {
|
||||
fmtPath = fmtPath.replace("{" + param.baseName + "}", "%v");
|
||||
}
|
||||
operation.vendorExtensions.put("x-terraform-path-fmt", fmtPath);
|
||||
}
|
||||
|
||||
// http method verb conversion (e.g. PUT => Put) as parent does
|
||||
operation.httpMethod = camelize(operation.httpMethod.toLowerCase(Locale.ROOT));
|
||||
}
|
||||
|
||||
// CRUD detection per tag
|
||||
CodegenOperation createOp = null;
|
||||
CodegenOperation readOp = null;
|
||||
CodegenOperation updateOp = null;
|
||||
CodegenOperation deleteOp = null;
|
||||
CodegenOperation listOp = null;
|
||||
|
||||
// First pass: check for explicit vendor extensions
|
||||
for (CodegenOperation op : operations) {
|
||||
if (getBooleanVendorExtension(op, "x-terraform-exclude")) {
|
||||
continue;
|
||||
}
|
||||
if (getBooleanVendorExtension(op, "x-terraform-is-create") && createOp == null) {
|
||||
createOp = op;
|
||||
}
|
||||
if (getBooleanVendorExtension(op, "x-terraform-is-read") && readOp == null) {
|
||||
readOp = op;
|
||||
}
|
||||
if (getBooleanVendorExtension(op, "x-terraform-is-update") && updateOp == null) {
|
||||
updateOp = op;
|
||||
}
|
||||
if (getBooleanVendorExtension(op, "x-terraform-is-delete") && deleteOp == null) {
|
||||
deleteOp = op;
|
||||
}
|
||||
if (getBooleanVendorExtension(op, "x-terraform-is-list") && listOp == null) {
|
||||
listOp = op;
|
||||
}
|
||||
}
|
||||
|
||||
// Second pass: auto-detect using REST pattern methods
|
||||
for (CodegenOperation op : operations) {
|
||||
if (getBooleanVendorExtension(op, "x-terraform-exclude")) {
|
||||
continue;
|
||||
}
|
||||
if (createOp == null && op.isRestfulCreate()) {
|
||||
createOp = op;
|
||||
} else if (readOp == null && op.isRestfulShow()) {
|
||||
readOp = op;
|
||||
} else if (updateOp == null && op.isRestfulUpdate()) {
|
||||
updateOp = op;
|
||||
} else if (deleteOp == null && op.isRestfulDestroy()) {
|
||||
deleteOp = op;
|
||||
} else if (listOp == null && op.isRestfulIndex()) {
|
||||
listOp = op;
|
||||
}
|
||||
}
|
||||
|
||||
// Mark the selected operations with vendor extensions
|
||||
if (createOp != null) {
|
||||
createOp.vendorExtensions.put("x-terraform-is-create", true);
|
||||
}
|
||||
if (readOp != null) {
|
||||
readOp.vendorExtensions.put("x-terraform-is-read", true);
|
||||
}
|
||||
if (updateOp != null) {
|
||||
updateOp.vendorExtensions.put("x-terraform-is-update", true);
|
||||
}
|
||||
if (deleteOp != null) {
|
||||
deleteOp.vendorExtensions.put("x-terraform-is-delete", true);
|
||||
}
|
||||
if (listOp != null) {
|
||||
listOp.vendorExtensions.put("x-terraform-is-list", true);
|
||||
}
|
||||
|
||||
// Tag-level flags and CRUD details for template rendering
|
||||
objectMap.put("hasCreate", createOp != null);
|
||||
objectMap.put("hasRead", readOp != null);
|
||||
objectMap.put("hasUpdate", updateOp != null);
|
||||
objectMap.put("hasDelete", deleteOp != null);
|
||||
objectMap.put("hasList", listOp != null);
|
||||
|
||||
// Store CRUD operation details at tag level for simplified template access
|
||||
if (createOp != null) {
|
||||
objectMap.put("createMethod", createOp.vendorExtensions.get("x-terraform-http-method"));
|
||||
objectMap.put("createPath", createOp.path);
|
||||
}
|
||||
if (readOp != null) {
|
||||
objectMap.put("readMethod", readOp.vendorExtensions.get("x-terraform-http-method"));
|
||||
objectMap.put("readPath", readOp.vendorExtensions.getOrDefault("x-terraform-path-fmt", readOp.path));
|
||||
objectMap.put("readHasPathParams", readOp.pathParams != null && !readOp.pathParams.isEmpty());
|
||||
}
|
||||
if (updateOp != null) {
|
||||
objectMap.put("updateMethod", updateOp.vendorExtensions.get("x-terraform-http-method"));
|
||||
objectMap.put("updatePath", updateOp.vendorExtensions.getOrDefault("x-terraform-path-fmt", updateOp.path));
|
||||
objectMap.put("updateHasPathParams", updateOp.pathParams != null && !updateOp.pathParams.isEmpty());
|
||||
}
|
||||
if (deleteOp != null) {
|
||||
objectMap.put("deleteMethod", deleteOp.vendorExtensions.get("x-terraform-http-method"));
|
||||
objectMap.put("deletePath", deleteOp.vendorExtensions.getOrDefault("x-terraform-path-fmt", deleteOp.path));
|
||||
objectMap.put("deleteHasPathParams", deleteOp.pathParams != null && !deleteOp.pathParams.isEmpty());
|
||||
}
|
||||
|
||||
// Determine resource name from tag
|
||||
String tag = objectMap.getClassname();
|
||||
// Strip common suffixes like "Api", "API" from the tag name
|
||||
String cleanTag = tag.replaceAll("(?i)api$", "");
|
||||
if (cleanTag.isEmpty()) {
|
||||
cleanTag = tag;
|
||||
}
|
||||
String resourceName = underscore(cleanTag).toLowerCase(Locale.ROOT);
|
||||
// Allow override via x-terraform-resource-name on any operation
|
||||
for (CodegenOperation op : operations) {
|
||||
Object nameOverride = op.vendorExtensions.get("x-terraform-resource-name");
|
||||
if (nameOverride != null) {
|
||||
resourceName = nameOverride.toString();
|
||||
break;
|
||||
}
|
||||
}
|
||||
objectMap.put("resourceName", resourceName);
|
||||
objectMap.put("resourceClassName", camelize(resourceName));
|
||||
|
||||
// Detect ID field from read operation path params
|
||||
String idField = "id";
|
||||
if (readOp != null && readOp.pathParams != null && !readOp.pathParams.isEmpty()) {
|
||||
idField = readOp.pathParams.get(readOp.pathParams.size() - 1).paramName;
|
||||
}
|
||||
objectMap.put("idField", idField);
|
||||
|
||||
// Build model info for the resource schema
|
||||
// Use the response type from readOp (or createOp) as the resource model
|
||||
String responseModel = null;
|
||||
if (readOp != null && readOp.returnType != null) {
|
||||
responseModel = readOp.returnType;
|
||||
} else if (createOp != null && createOp.returnType != null) {
|
||||
responseModel = createOp.returnType;
|
||||
}
|
||||
objectMap.put("responseModel", responseModel);
|
||||
|
||||
// Build request model from createOp body params
|
||||
String requestModel = null;
|
||||
if (createOp != null && createOp.bodyParam != null && createOp.bodyParam.dataType != null) {
|
||||
requestModel = createOp.bodyParam.dataType;
|
||||
}
|
||||
objectMap.put("requestModel", requestModel);
|
||||
|
||||
// Collect model properties for schema generation and resolve ID field
|
||||
String idModelGoName = camelize(idField);
|
||||
String idModelGoType = "string";
|
||||
|
||||
if (responseModel != null) {
|
||||
for (ModelMap modelMap : allModels) {
|
||||
CodegenModel model = modelMap.getModel();
|
||||
if (model.classname.equals(responseModel)) {
|
||||
List<Map<String, Object>> tfAttributes = new ArrayList<>();
|
||||
boolean hasListAttributes = false;
|
||||
for (CodegenProperty prop : model.vars) {
|
||||
Map<String, Object> attr = new HashMap<>();
|
||||
attr.put("name", prop.baseName);
|
||||
attr.put("terraformName", underscore(prop.baseName).toLowerCase(Locale.ROOT));
|
||||
attr.put("goName", camelize(prop.baseName));
|
||||
attr.put("goType", prop.dataType);
|
||||
attr.put("terraformType", goTypeToTerraformType(prop.dataType));
|
||||
attr.put("terraformAttrType", goTypeToTerraformAttrType(prop.dataType, prop));
|
||||
attr.put("isRequired", prop.required);
|
||||
attr.put("isComputed", prop.isReadOnly);
|
||||
attr.put("isOptional", !prop.required && !prop.isReadOnly);
|
||||
attr.put("description", prop.description != null ? prop.description : "");
|
||||
attr.put("isSensitive", prop.isWriteOnly || getBooleanVendorExtension(prop, "x-terraform-sensitive"));
|
||||
attr.put("isString", "string".equals(prop.dataType));
|
||||
attr.put("isInt64", "int64".equals(prop.dataType) || "int32".equals(prop.dataType));
|
||||
attr.put("isFloat64", "float64".equals(prop.dataType) || "float32".equals(prop.dataType));
|
||||
attr.put("isBool", "bool".equals(prop.dataType));
|
||||
attr.put("isList", prop.isArray);
|
||||
attr.put("isObject", prop.isModel && !prop.isArray);
|
||||
if (prop.isArray) {
|
||||
hasListAttributes = true;
|
||||
if (prop.items != null) {
|
||||
attr.put("listElementType", goTypeToTerraformElementType(prop.items.dataType));
|
||||
}
|
||||
}
|
||||
tfAttributes.add(attr);
|
||||
}
|
||||
objectMap.put("tfAttributes", tfAttributes);
|
||||
objectMap.put("hasListAttributes", hasListAttributes);
|
||||
|
||||
// Resolve ID field: match path param name to a model property
|
||||
boolean idResolved = false;
|
||||
// Try exact match on baseName (case-insensitive)
|
||||
for (CodegenProperty prop : model.vars) {
|
||||
if (prop.baseName.equalsIgnoreCase(idField)) {
|
||||
idModelGoName = camelize(prop.baseName);
|
||||
idModelGoType = prop.dataType;
|
||||
idResolved = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
// Try stripping resource name prefix (e.g., petId -> id)
|
||||
if (!idResolved) {
|
||||
String strippedId = idField.replaceFirst("(?i)^" + resourceName, "");
|
||||
if (!strippedId.isEmpty()) {
|
||||
for (CodegenProperty prop : model.vars) {
|
||||
if (prop.baseName.equalsIgnoreCase(strippedId)) {
|
||||
idModelGoName = camelize(prop.baseName);
|
||||
idModelGoType = prop.dataType;
|
||||
idResolved = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// Fall back to "id" property
|
||||
if (!idResolved) {
|
||||
for (CodegenProperty prop : model.vars) {
|
||||
if ("id".equalsIgnoreCase(prop.baseName)) {
|
||||
idModelGoName = camelize(prop.baseName);
|
||||
idModelGoType = prop.dataType;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
objectMap.put("idFieldExported", idModelGoName);
|
||||
|
||||
// Determine the value accessor for the ID field based on its type
|
||||
String idValueAccessor;
|
||||
if ("int64".equals(idModelGoType) || "int32".equals(idModelGoType) || "int".equals(idModelGoType)) {
|
||||
idValueAccessor = ".ValueInt64()";
|
||||
} else if ("float64".equals(idModelGoType) || "float32".equals(idModelGoType)) {
|
||||
idValueAccessor = ".ValueFloat64()";
|
||||
} else {
|
||||
idValueAccessor = ".ValueString()";
|
||||
}
|
||||
objectMap.put("idFieldValueAccessor", idValueAccessor);
|
||||
|
||||
// Terraform name for the ID field (for path.Root in ImportState)
|
||||
objectMap.put("idFieldTerraformName", underscore(idModelGoName).toLowerCase(Locale.ROOT));
|
||||
|
||||
return objs;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ModelsMap postProcessModels(ModelsMap objs) {
|
||||
// Call parent to handle Go-specific post-processing
|
||||
objs = super.postProcessModels(objs);
|
||||
|
||||
for (ModelMap m : objs.getModels()) {
|
||||
CodegenModel model = m.getModel();
|
||||
for (CodegenProperty prop : model.vars) {
|
||||
// Ensure x-go-datatag is set for all model vars.
|
||||
// The parent AbstractGoCodegen only sets x-go-datatag on
|
||||
// inheritedProperties (oneOf/anyOf entries) when the model has
|
||||
// composed schemas without allOf, leaving model.vars without
|
||||
// json tags. We fix this by generating the tag here when missing.
|
||||
if (!prop.vendorExtensions.containsKey("x-go-datatag")) {
|
||||
String goDataTag = "json:\"" + prop.baseName;
|
||||
if (!prop.required) {
|
||||
goDataTag += ",omitempty";
|
||||
}
|
||||
goDataTag += "\"";
|
||||
goDataTag = " `" + goDataTag + "`";
|
||||
prop.vendorExtensions.put("x-go-datatag", goDataTag);
|
||||
}
|
||||
|
||||
// Add Terraform-specific vendor extensions
|
||||
if (prop.isReadOnly) {
|
||||
prop.vendorExtensions.put("x-terraform-computed", true);
|
||||
}
|
||||
if (prop.required) {
|
||||
prop.vendorExtensions.put("x-terraform-required", true);
|
||||
}
|
||||
if (!prop.required && !prop.isReadOnly) {
|
||||
prop.vendorExtensions.put("x-terraform-optional", true);
|
||||
}
|
||||
if (prop.isWriteOnly) {
|
||||
prop.vendorExtensions.put("x-terraform-sensitive", true);
|
||||
}
|
||||
|
||||
// Map Go types to Terraform types
|
||||
prop.vendorExtensions.put("x-terraform-type", goTypeToTerraformType(prop.dataType));
|
||||
prop.vendorExtensions.put("x-terraform-attr-type", goTypeToTerraformAttrType(prop.dataType, prop));
|
||||
}
|
||||
}
|
||||
|
||||
return objs;
|
||||
}
|
||||
|
||||
private String goTypeToTerraformType(String goType) {
|
||||
if (goType == null) return "types.String";
|
||||
switch (goType) {
|
||||
case "string":
|
||||
return "types.String";
|
||||
case "int32":
|
||||
case "int64":
|
||||
case "int":
|
||||
return "types.Int64";
|
||||
case "float32":
|
||||
case "float64":
|
||||
return "types.Float64";
|
||||
case "bool":
|
||||
return "types.Bool";
|
||||
default:
|
||||
if (goType.startsWith("[]")) {
|
||||
return "types.List";
|
||||
}
|
||||
return "types.String";
|
||||
}
|
||||
}
|
||||
|
||||
private String goTypeToTerraformAttrType(String goType, CodegenProperty prop) {
|
||||
if (goType == null) return "schema.StringAttribute";
|
||||
switch (goType) {
|
||||
case "string":
|
||||
return "schema.StringAttribute";
|
||||
case "int32":
|
||||
case "int64":
|
||||
case "int":
|
||||
return "schema.Int64Attribute";
|
||||
case "float32":
|
||||
case "float64":
|
||||
return "schema.Float64Attribute";
|
||||
case "bool":
|
||||
return "schema.BoolAttribute";
|
||||
default:
|
||||
if (goType.startsWith("[]")) {
|
||||
return "schema.ListAttribute";
|
||||
}
|
||||
// Complex objects are serialized as JSON strings
|
||||
return "schema.StringAttribute";
|
||||
}
|
||||
}
|
||||
|
||||
private String goTypeToTerraformElementType(String goType) {
|
||||
if (goType == null) return "types.StringType";
|
||||
switch (goType) {
|
||||
case "string":
|
||||
return "types.StringType";
|
||||
case "int32":
|
||||
case "int64":
|
||||
case "int":
|
||||
return "types.Int64Type";
|
||||
case "float32":
|
||||
case "float64":
|
||||
return "types.Float64Type";
|
||||
case "bool":
|
||||
return "types.BoolType";
|
||||
default:
|
||||
return "types.StringType";
|
||||
}
|
||||
}
|
||||
|
||||
private boolean getBooleanVendorExtension(CodegenOperation op, String key) {
|
||||
return op.vendorExtensions.containsKey(key) && Boolean.TRUE.equals(op.vendorExtensions.get(key));
|
||||
}
|
||||
|
||||
private boolean getBooleanVendorExtension(CodegenProperty prop, String key) {
|
||||
return prop.vendorExtensions.containsKey(key) && Boolean.TRUE.equals(prop.vendorExtensions.get(key));
|
||||
}
|
||||
}
|
||||
@@ -51,7 +51,7 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege
|
||||
public static final String IMPORT_FILE_EXTENSION_SWITCH_DESC = "File extension to use with relative imports. Set it to '.js' or '.mjs' when using [ESM](https://nodejs.org/api/esm.html).";
|
||||
public static final String USE_SQUARE_BRACKETS_IN_ARRAY_NAMES = "useSquareBracketsInArrayNames";
|
||||
public static final String AXIOS_VERSION = "axiosVersion";
|
||||
public static final String DEFAULT_AXIOS_VERSION = "^1.6.1";
|
||||
public static final String DEFAULT_AXIOS_VERSION = "^1.13.5";
|
||||
public static final String WITH_AWSV4_SIGNATURE = "withAWSV4Signature";
|
||||
|
||||
@Getter @Setter
|
||||
|
||||
@@ -78,6 +78,9 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
|
||||
private static final String USE_OBJECT_PARAMS_SWITCH = "useObjectParameters";
|
||||
private static final String USE_OBJECT_PARAMS_DESC = "Use aggregate parameter objects as function arguments for api operations instead of passing each parameter as a separate function argument.";
|
||||
|
||||
protected static final String TYPESCRIPT_MAJOR_VERSION_SWTICH = "typescriptMajorVersion";
|
||||
private static final String TYPESCRIPT_MAJOR_VERSION_DESC = "Specify the major version of TypeScript to use in the client code. Default is 5.";
|
||||
|
||||
public static final String USE_ERASABLE_SYNTAX = "useErasableSyntax";
|
||||
public static final String USE_ERASABLE_SYNTAX_DESC = "Use erasable syntax for the generated code. This is a temporary feature and will be removed in the future.";
|
||||
|
||||
@@ -97,6 +100,9 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
|
||||
protected String snapshot = null;
|
||||
protected ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming = ENUM_PROPERTY_NAMING_TYPE.PascalCase;
|
||||
|
||||
@Getter @Setter
|
||||
protected String typescriptMajorVersion = "5";
|
||||
|
||||
private final DateTimeFormatter iso8601Date = DateTimeFormatter.ISO_DATE;
|
||||
private final DateTimeFormatter iso8601DateTime = DateTimeFormatter.ISO_DATE_TIME;
|
||||
|
||||
@@ -131,6 +137,7 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.USE_RXJS_SWITCH, TypeScriptClientCodegen.USE_RXJS_SWITCH_DESC).defaultValue("false"));
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.USE_OBJECT_PARAMS_SWITCH, TypeScriptClientCodegen.USE_OBJECT_PARAMS_DESC).defaultValue("false"));
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.USE_INVERSIFY_SWITCH, TypeScriptClientCodegen.USE_INVERSIFY_SWITCH_DESC).defaultValue("false"));
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.TYPESCRIPT_MAJOR_VERSION_SWTICH, TypeScriptClientCodegen.TYPESCRIPT_MAJOR_VERSION_DESC).defaultValue(this.getTypescriptMajorVersion()));
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.IMPORT_FILE_EXTENSION_SWITCH, TypeScriptClientCodegen.IMPORT_FILE_EXTENSION_SWITCH_DESC));
|
||||
cliOptions.add(new CliOption(TypeScriptClientCodegen.USE_ERASABLE_SYNTAX, TypeScriptClientCodegen.USE_ERASABLE_SYNTAX_DESC).defaultValue("false"));
|
||||
|
||||
@@ -495,6 +502,8 @@ public class TypeScriptClientCodegen extends AbstractTypeScriptClientCodegen imp
|
||||
if (additionalProperties.containsKey(NPM_REPOSITORY)) {
|
||||
setNpmRepository(additionalProperties.get(NPM_REPOSITORY).toString());
|
||||
}
|
||||
|
||||
additionalProperties.put(TYPESCRIPT_MAJOR_VERSION_SWTICH, typescriptMajorVersion);
|
||||
}
|
||||
|
||||
private String getHttpLibForFramework(String object) {
|
||||
|
||||
@@ -383,6 +383,7 @@ public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodege
|
||||
|
||||
@Override
|
||||
public ModelsMap postProcessModels(ModelsMap objs) {
|
||||
// postProcessModelsEnum applies inner enum fixes via the parent class override
|
||||
List<ModelMap> models = postProcessModelsEnum(objs).getModels();
|
||||
|
||||
// process enum and custom properties in models
|
||||
@@ -800,7 +801,8 @@ public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodege
|
||||
for (CodegenProperty cpVar : cm.allVars) {
|
||||
ExtendedCodegenProperty var = (ExtendedCodegenProperty) cpVar;
|
||||
|
||||
if (Boolean.TRUE.equals(var.isEnum)) {
|
||||
// Handle both direct enum properties and inner enums (maps/arrays of enums)
|
||||
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
|
||||
var.datatypeWithEnum = var.datatypeWithEnum
|
||||
.replace(var.enumName, cm.classname + var.enumName);
|
||||
}
|
||||
@@ -845,7 +847,9 @@ public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodege
|
||||
|
||||
private boolean processCodegenProperty(ExtendedCodegenProperty var, String parentClassName, Object xEntityId) {
|
||||
// name enum with model name, e.g. StatusEnum => PetStatusEnum
|
||||
if (Boolean.TRUE.equals(var.isEnum)) {
|
||||
// This applies to both direct enum properties (isEnum) and properties containing
|
||||
// inner enums (isInnerEnum) like maps or arrays of enums.
|
||||
if (Boolean.TRUE.equals(var.isEnum) || Boolean.TRUE.equals(var.isInnerEnum)) {
|
||||
// behaviour for enum names is specific for Typescript Fetch, not using namespaces
|
||||
var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, parentClassName + var.enumName);
|
||||
|
||||
@@ -1525,11 +1529,11 @@ public class TypeScriptFetchClientCodegen extends AbstractTypeScriptClientCodege
|
||||
public Set<CodegenProperty> oneOfPrimitives = new HashSet<>();
|
||||
@Getter @Setter
|
||||
public CodegenDiscriminator.MappedModel selfReferencingDiscriminatorMapping;
|
||||
|
||||
|
||||
public boolean isEntity; // Is a model containing an "id" property marked as isUniqueId
|
||||
public String returnPassthrough;
|
||||
public boolean hasReturnPassthroughVoid;
|
||||
|
||||
|
||||
public boolean hasSelfReferencingDiscriminatorMapping(){
|
||||
return selfReferencingDiscriminatorMapping != null;
|
||||
}
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
package {{invokerPackage}}
|
||||
|
||||
{{#withXml}}
|
||||
import java.io.StringReader
|
||||
import {{javaxPackage}}.xml.bind.JAXB
|
||||
{{/withXml}}
|
||||
import groovy.json.JsonBuilder
|
||||
import groovy.json.JsonGenerator
|
||||
import groovyx.net.http.ChainedHttpConfig
|
||||
import groovyx.net.http.ContentTypes
|
||||
import groovyx.net.http.NativeHandlers
|
||||
import groovyx.net.http.FromServer
|
||||
import groovyx.net.http.ToServer
|
||||
|
||||
import static groovyx.net.http.HttpBuilder.configure
|
||||
@@ -18,24 +23,42 @@ class ApiUtils {
|
||||
}
|
||||
.build()
|
||||
|
||||
void invokeApi(onSuccess, onFailure, basePath, versionPath, resourcePath, queryParams, headerParams, bodyParams, contentType, method, container, type) {
|
||||
void invokeApi(onSuccess, onFailure, basePath, versionPath, resourcePath, queryParams, headerParams, bodyParams, accept, contentType, method, container, type) {
|
||||
def (url, uriPath) = buildUrlAndUriPath(basePath, versionPath, resourcePath)
|
||||
println "url=$url uriPath=$uriPath"
|
||||
def http = configure {
|
||||
request.uri = url
|
||||
request.uri.path = uriPath
|
||||
request.encoder(ContentTypes.JSON, { final ChainedHttpConfig config, final ToServer ts ->
|
||||
final ChainedHttpConfig.ChainedRequest request = config.getChainedRequest();
|
||||
final ChainedHttpConfig.ChainedRequest request = config.getChainedRequest()
|
||||
if (NativeHandlers.Encoders.handleRawUpload(config, ts)) {
|
||||
return;
|
||||
return
|
||||
}
|
||||
|
||||
final Object body = NativeHandlers.Encoders.checkNull(request.actualBody());
|
||||
final Object body = NativeHandlers.Encoders.checkNull(request.actualBody())
|
||||
final String json = ((body instanceof String || body instanceof GString)
|
||||
? body.toString()
|
||||
: new JsonBuilder(body, jsonGenerator).toString());
|
||||
ts.toServer(NativeHandlers.Encoders.stringToStream(json, request.actualCharset()));
|
||||
: new JsonBuilder(body, jsonGenerator).toString())
|
||||
ts.toServer(NativeHandlers.Encoders.stringToStream(json, request.actualCharset()))
|
||||
})
|
||||
{{#withXml}}
|
||||
request.encoder(ContentTypes.XML, { final ChainedHttpConfig config, final ToServer ts ->
|
||||
final ChainedHttpConfig.ChainedRequest request = config.getChainedRequest()
|
||||
if (NativeHandlers.Encoders.handleRawUpload(config, ts)) {
|
||||
return
|
||||
}
|
||||
|
||||
final Object body = NativeHandlers.Encoders.checkNull(request.actualBody())
|
||||
String xml
|
||||
if (body instanceof String || body instanceof GString) {
|
||||
xml = body.toString()
|
||||
} else {
|
||||
StringWriter writer = new StringWriter()
|
||||
JAXB.marshal(body, writer)
|
||||
xml = writer.toString()
|
||||
}
|
||||
ts.toServer(NativeHandlers.Encoders.stringToStream(xml, request.actualCharset()))
|
||||
}){{/withXml}}
|
||||
}
|
||||
.invokeMethod(String.valueOf(method).toLowerCase()) {
|
||||
request.uri.query = queryParams
|
||||
@@ -43,11 +66,16 @@ class ApiUtils {
|
||||
if (bodyParams != null) {
|
||||
request.body = bodyParams
|
||||
}
|
||||
request.accept = accept
|
||||
request.contentType = contentType
|
||||
|
||||
response.success { resp, json ->
|
||||
{{#withXml}}
|
||||
response.parser(ContentTypes.XML) { final ChainedHttpConfig cfg, final FromServer fs ->
|
||||
fs.inputStream.text
|
||||
}
|
||||
{{/withXml}}
|
||||
response.success { resp, body ->
|
||||
if (type != null) {
|
||||
onSuccess(parse(json, container, type))
|
||||
onSuccess(parse(resp, body, container, type))
|
||||
}
|
||||
}
|
||||
response.failure { resp ->
|
||||
@@ -68,12 +96,24 @@ class ApiUtils {
|
||||
[basePath-pathOnly, pathOnly+versionPath+resourcePath]
|
||||
}
|
||||
|
||||
private def parse(object, container, clazz) {
|
||||
private def parse(response, object, container, clazz) {
|
||||
{{#withXml}}
|
||||
if (response.getContentType().toLowerCase().contains("xml")) {
|
||||
return JAXB.unmarshal(new StringReader(object), clazz)
|
||||
}
|
||||
{{/withXml}}
|
||||
if (container == "array") {
|
||||
return object.collect {parse(it, "", clazz)}
|
||||
} else {
|
||||
return object.collect { parse(response, it, "", clazz) }
|
||||
} else {
|
||||
return clazz.newInstance(object)
|
||||
}
|
||||
}
|
||||
|
||||
private def selectHeaderAccept(accepts) {
|
||||
def jsonMime = 'application/json'
|
||||
if (accepts.find { it.toLowerCase().startsWith(jsonMime) }) {
|
||||
return [jsonMime]
|
||||
}
|
||||
return accepts
|
||||
}
|
||||
}
|
||||
|
||||
@@ -18,6 +18,7 @@ class {{classname}} {
|
||||
def queryParams = [:]
|
||||
def headerParams = [:]
|
||||
def bodyParams
|
||||
def accept
|
||||
def contentType
|
||||
|
||||
{{#allParams}}
|
||||
@@ -71,7 +72,9 @@ class {{classname}} {
|
||||
{{/formParams}}
|
||||
{{/hasFormParams}}
|
||||
|
||||
apiUtils.invokeApi(onSuccess, onFailure, basePath, versionPath, resourcePath, queryParams, headerParams, bodyParams, contentType,
|
||||
accept = apiUtils.selectHeaderAccept([{{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}}])
|
||||
|
||||
apiUtils.invokeApi(onSuccess, onFailure, basePath, versionPath, resourcePath, queryParams, headerParams, bodyParams, accept, contentType,
|
||||
"{{httpMethod}}", "{{returnContainer}}",
|
||||
{{#returnBaseType}}{{{.}}}.class {{/returnBaseType}}{{^returnBaseType}}null {{/returnBaseType}})
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
apply plugin: 'groovy'
|
||||
apply plugin: 'idea'
|
||||
apply plugin: 'eclipse'
|
||||
apply plugin: 'com.github.johnrengelman.shadow'
|
||||
|
||||
group = '{{groupId}}'
|
||||
version = '{{artifactVersion}}'
|
||||
@@ -18,6 +19,7 @@ buildscript {
|
||||
}
|
||||
dependencies {
|
||||
classpath(group: 'org.jfrog.buildinfo', name: 'build-info-extractor-gradle', version: '4.24.20')
|
||||
classpath('com.github.johnrengelman.shadow:com.github.johnrengelman.shadow.gradle.plugin:4.0.4')
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -4,6 +4,9 @@ import groovy.transform.Canonical
|
||||
{{#imports}}
|
||||
import {{import}};
|
||||
{{/imports}}
|
||||
{{#withXml}}
|
||||
import {{javaxPackage}}.xml.bind.annotation.*;
|
||||
{{/withXml}}
|
||||
|
||||
{{#models}}
|
||||
{{#model}}
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
{{#withXml}}
|
||||
@XmlAccessorType(XmlAccessType.NONE)
|
||||
{{/withXml}}
|
||||
@Canonical
|
||||
class {{classname}} {
|
||||
{{#vars}}
|
||||
@@ -16,6 +19,12 @@ class {{classname}} {
|
||||
|
||||
{{/isEnum}}
|
||||
{{#description}}/* {{{.}}} */{{/description}}
|
||||
{{#withXml}}
|
||||
@Xml{{#isXmlAttribute}}Attribute{{/isXmlAttribute}}{{^isXmlAttribute}}Element{{/isXmlAttribute}}(name = "{{items.xmlName}}{{^items.xmlName}}{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}{{/items.xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}})
|
||||
{{#isXmlWrapped}}
|
||||
@XmlElementWrapper(name = "{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}})
|
||||
{{/isXmlWrapped}}
|
||||
{{/withXml}}
|
||||
{{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}
|
||||
{{/vars}}
|
||||
}
|
||||
@@ -1,3 +1,6 @@
|
||||
{{#withXml}}
|
||||
@XmlEnum
|
||||
{{/withXml}}
|
||||
enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
|
||||
{{#allowableValues}}{{#enumVars}}
|
||||
{{#enumDescription}}
|
||||
@@ -5,6 +8,9 @@ enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEn
|
||||
* {{.}}
|
||||
*/
|
||||
{{/enumDescription}}
|
||||
{{#withXml}}
|
||||
@XmlEnumValue({{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}{{{value}}}{{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}})
|
||||
{{/withXml}}
|
||||
{{{name}}}({{{value}}}){{^-last}},
|
||||
{{/-last}}{{/enumVars}}{{/allowableValues}}
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ ext {
|
||||
jackson_version = "2.19.2"
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "1.3.5"
|
||||
{{#useBeanValidation}}
|
||||
|
||||
@@ -117,7 +117,7 @@ ext {
|
||||
jackson_version = "2.19.2"
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "1.3.5"
|
||||
httpclient_version = "5.1.3"
|
||||
|
||||
@@ -354,7 +354,7 @@
|
||||
<jackson-version>2.19.2</jackson-version>
|
||||
<jackson-databind-version>2.19.2</jackson-databind-version>
|
||||
{{#openApiNullable}}
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{/openApiNullable}}
|
||||
{{#useJakartaEe}}
|
||||
<jakarta-annotation-version>2.1.1</jakarta-annotation-version>
|
||||
|
||||
@@ -34,6 +34,12 @@ import feign.jackson.JacksonEncoder;
|
||||
import feign.gson.GsonDecoder;
|
||||
import feign.gson.GsonEncoder;
|
||||
{{/gson}}
|
||||
{{#feign-okhttp}}
|
||||
import feign.okhttp.OkHttpClient;
|
||||
{{/feign-okhttp}}
|
||||
{{#feign-hc5}}
|
||||
import feign.hc5.ApacheHttp5Client;
|
||||
{{/feign-hc5}}
|
||||
import feign.slf4j.Slf4jLogger;
|
||||
import {{invokerPackage}}.auth.HttpBasicAuth;
|
||||
import {{invokerPackage}}.auth.HttpBearerAuth;
|
||||
@@ -65,12 +71,24 @@ public class ApiClient {
|
||||
protected String basePath = "{{{basePath}}}";
|
||||
protected Map<String, RequestInterceptor> apiAuthorizations;
|
||||
protected Feign.Builder feignBuilder;
|
||||
{{#feign-okhttp}}
|
||||
private static final OkHttpClient OK_HTTP_CLIENT = new OkHttpClient();
|
||||
{{/feign-okhttp}}
|
||||
{{#feign-hc5}}
|
||||
private static final ApacheHttp5Client APACHE_HTTP5_CLIENT = new ApacheHttp5Client();
|
||||
{{/feign-hc5}}
|
||||
|
||||
public ApiClient() {
|
||||
apiAuthorizations = new LinkedHashMap<String, RequestInterceptor>();
|
||||
{{#jackson}}
|
||||
objectMapper = createObjectMapper();
|
||||
feignBuilder = Feign.builder()
|
||||
{{#feign-okhttp}}
|
||||
.client(OK_HTTP_CLIENT)
|
||||
{{/feign-okhttp}}
|
||||
{{#feign-hc5}}
|
||||
.client(APACHE_HTTP5_CLIENT)
|
||||
{{/feign-hc5}}
|
||||
.encoder(new FormEncoder(new JacksonEncoder(objectMapper)))
|
||||
.decoder(new ApiResponseDecoder(objectMapper))
|
||||
{{#hasOAuthMethods}}
|
||||
@@ -81,6 +99,12 @@ public class ApiClient {
|
||||
{{/jackson}}
|
||||
{{#gson}}
|
||||
feignBuilder = Feign.builder()
|
||||
{{#feign-okhttp}}
|
||||
.client(OK_HTTP_CLIENT)
|
||||
{{/feign-okhttp}}
|
||||
{{#feign-hc5}}
|
||||
.client(APACHE_HTTP5_CLIENT)
|
||||
{{/feign-hc5}}
|
||||
.encoder(new FormEncoder(new GsonEncoder()))
|
||||
.decoder(new GsonDecoder())
|
||||
{{#hasOAuthMethods}}
|
||||
|
||||
@@ -7,33 +7,99 @@ import feign.Response;
|
||||
import feign.Types;
|
||||
import feign.jackson.JacksonDecoder;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.lang.reflect.ParameterizedType;
|
||||
import java.lang.reflect.Type;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.nio.file.StandardCopyOption;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.Map;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import {{modelPackage}}.ApiResponse;
|
||||
|
||||
public class ApiResponseDecoder extends JacksonDecoder {
|
||||
|
||||
private static final Pattern FILENAME_PATTERN =
|
||||
Pattern.compile("filename=\"([^\"]+)\"|filename=([^\\s;]+)");
|
||||
|
||||
public ApiResponseDecoder(ObjectMapper mapper) {
|
||||
super(mapper);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Object decode(Response response, Type type) throws IOException {
|
||||
//Detects if the type is an instance of the parameterized class ApiResponse
|
||||
if (type instanceof ParameterizedType && Types.getRawType(type).isAssignableFrom(ApiResponse.class)) {
|
||||
//The ApiResponse class has a single type parameter, the Dto class itself
|
||||
Type responseBodyType = ((ParameterizedType) type).getActualTypeArguments()[0];
|
||||
Object body = super.decode(response, responseBodyType);
|
||||
Object body = isBinaryType(responseBodyType)
|
||||
? decodeBinary(response, responseBodyType)
|
||||
: super.decode(response, responseBodyType);
|
||||
Map<String, Collection<String>> responseHeaders = Collections.unmodifiableMap(response.headers());
|
||||
return new ApiResponse<>(response.status(), responseHeaders, body);
|
||||
} else {
|
||||
//The response is not encapsulated in the ApiResponse, decode the Dto as normal
|
||||
return super.decode(response, type);
|
||||
}
|
||||
|
||||
if (isBinaryType(type)) {
|
||||
return decodeBinary(response, type);
|
||||
}
|
||||
|
||||
return super.decode(response, type);
|
||||
}
|
||||
|
||||
private boolean isBinaryType(Type type) {
|
||||
Class<?> raw = Types.getRawType(type);
|
||||
return File.class.isAssignableFrom(raw)
|
||||
|| byte[].class.isAssignableFrom(raw)
|
||||
|| InputStream.class.isAssignableFrom(raw);
|
||||
}
|
||||
|
||||
private Object decodeBinary(Response response, Type type) throws IOException {
|
||||
Class<?> raw = Types.getRawType(type);
|
||||
if (response.body() == null) {
|
||||
return null;
|
||||
}
|
||||
if (byte[].class.isAssignableFrom(raw)) {
|
||||
return response.body().asInputStream().readAllBytes();
|
||||
}
|
||||
if (InputStream.class.isAssignableFrom(raw)) {
|
||||
return response.body().asInputStream();
|
||||
}
|
||||
return downloadToTempFile(response);
|
||||
}
|
||||
|
||||
private File downloadToTempFile(Response response) throws IOException {
|
||||
String filename = extractFilename(response);
|
||||
File file;
|
||||
if (filename != null) {
|
||||
// Sanitize: strip path components to prevent path traversal
|
||||
String safeName = Paths.get(filename).getFileName().toString();
|
||||
java.nio.file.Path tempDir = Files.createTempDirectory("feign-download");
|
||||
file = Files.createFile(tempDir.resolve(safeName)).toFile();
|
||||
tempDir.toFile().deleteOnExit();
|
||||
} else {
|
||||
file = Files.createTempFile("download-", "").toFile();
|
||||
}
|
||||
file.deleteOnExit();
|
||||
try (InputStream is = response.body().asInputStream()) {
|
||||
Files.copy(is, file.toPath(), StandardCopyOption.REPLACE_EXISTING);
|
||||
}
|
||||
return file;
|
||||
}
|
||||
|
||||
private String extractFilename(Response response) {
|
||||
Collection<String> dispositions = response.headers().get("Content-Disposition");
|
||||
if (dispositions == null) return null;
|
||||
for (String disposition : dispositions) {
|
||||
Matcher m = FILENAME_PATTERN.matcher(disposition);
|
||||
if (m.find()) {
|
||||
// Group 1: quoted filename (may contain spaces), Group 2: unquoted token
|
||||
return m.group(1) != null ? m.group(1) : m.group(2);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -107,7 +107,7 @@ ext {
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{/jackson}}
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "1.3.5"
|
||||
feign_version = "13.5"
|
||||
|
||||
@@ -416,7 +416,7 @@
|
||||
<gson-version>2.10.1</gson-version>
|
||||
{{/gson}}
|
||||
{{#openApiNullable}}
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{/openApiNullable}}
|
||||
{{#useJakartaEe}}
|
||||
<jakarta-annotation-version>2.1.1</jakarta-annotation-version>
|
||||
|
||||
@@ -101,7 +101,7 @@ ext {
|
||||
jackson_version = "2.19.2"
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "1.3.5"
|
||||
google_api_client_version = "1.32.2"
|
||||
|
||||
@@ -313,7 +313,7 @@
|
||||
<jackson-version>2.19.2</jackson-version>
|
||||
<jackson-databind-version>2.19.2</jackson-databind-version>
|
||||
{{#openApiNullable}}
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{/openApiNullable}}
|
||||
{{#joda}}
|
||||
<jodatime-version>2.9.9</jodatime-version>
|
||||
|
||||
@@ -107,7 +107,7 @@ ext {
|
||||
jackson_version = "2.19.2"
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "1.3.5"
|
||||
{{#useBeanValidation}}
|
||||
|
||||
@@ -24,7 +24,7 @@ lazy val root = (project in file(".")).
|
||||
{{/joda}}
|
||||
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.19.2" % "compile",
|
||||
{{#openApiNullable}}
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.8" % "compile",
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.9" % "compile",
|
||||
{{/openApiNullable}}
|
||||
{{#hasOAuthMethods}}
|
||||
"com.github.scribejava" % "scribejava-apis" % "8.3.1" % "compile",
|
||||
|
||||
@@ -407,7 +407,7 @@
|
||||
<jersey-version>2.37</jersey-version>
|
||||
<jackson-version>2.19.2</jackson-version>
|
||||
<jackson-databind-version>2.19.2</jackson-databind-version>
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{#useJakartaEe}}
|
||||
<jakarta-annotation-version>2.1.1</jakarta-annotation-version>
|
||||
<beanvalidation-version>3.0.2</beanvalidation-version>
|
||||
|
||||
@@ -102,7 +102,7 @@ ext {
|
||||
jackson_version = "2.19.2"
|
||||
jackson_databind_version = "2.19.2"
|
||||
{{#openApiNullable}}
|
||||
jackson_databind_nullable_version = "0.2.8"
|
||||
jackson_databind_nullable_version = "0.2.9"
|
||||
{{/openApiNullable}}
|
||||
jakarta_annotation_version = "2.1.0"
|
||||
{{#useBeanValidation}}
|
||||
|
||||
@@ -24,7 +24,7 @@ lazy val root = (project in file(".")).
|
||||
{{/joda}}
|
||||
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.19.2" % "compile",
|
||||
{{#openApiNullable}}
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.8" % "compile",
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.9" % "compile",
|
||||
{{/openApiNullable}}
|
||||
{{#hasOAuthMethods}}
|
||||
"com.github.scribejava" % "scribejava-apis" % "8.3.1" % "compile",
|
||||
|
||||
@@ -407,7 +407,7 @@
|
||||
<jersey-version>3.1.11</jersey-version>
|
||||
<jackson-version>2.19.2</jackson-version>
|
||||
<jackson-databind-version>2.19.2</jackson-databind-version>
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{#useJakartaEe}}
|
||||
<jakarta-annotation-version>2.1.1</jakarta-annotation-version>
|
||||
<beanvalidation-version>3.0.2</beanvalidation-version>
|
||||
|
||||
@@ -102,7 +102,7 @@ dependencies {
|
||||
implementation "com.fasterxml.jackson.core:jackson-annotations:$jackson_version"
|
||||
implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_version"
|
||||
implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version"
|
||||
implementation "org.openapitools:jackson-databind-nullable:0.2.8"
|
||||
implementation "org.openapitools:jackson-databind-nullable:0.2.9"
|
||||
implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
|
||||
{{#useBeanValidation}}
|
||||
implementation "jakarta.validation:jakarta.validation-api:$beanvalidation_version"
|
||||
|
||||
@@ -300,7 +300,7 @@
|
||||
<maven.compiler.source>11</maven.compiler.source>
|
||||
<maven.compiler.target>11</maven.compiler.target>
|
||||
<jackson-version>2.19.2</jackson-version>
|
||||
<jackson-databind-nullable-version>0.2.8</jackson-databind-nullable-version>
|
||||
<jackson-databind-nullable-version>0.2.9</jackson-databind-nullable-version>
|
||||
{{#useJakartaEe}}
|
||||
<jakarta-annotation-version>2.1.1</jakarta-annotation-version>
|
||||
<beanvalidation-version>3.0.2</beanvalidation-version>
|
||||
|
||||
@@ -132,7 +132,7 @@ dependencies {
|
||||
implementation 'io.gsonfire:gson-fire:1.9.0'
|
||||
implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6'
|
||||
{{#openApiNullable}}
|
||||
implementation 'org.openapitools:jackson-databind-nullable:0.2.8'
|
||||
implementation 'org.openapitools:jackson-databind-nullable:0.2.9'
|
||||
{{/openApiNullable}}
|
||||
{{#withAWSV4Signature}}
|
||||
implementation 'software.amazon.awssdk:auth:2.20.157'
|
||||
|
||||
@@ -16,7 +16,7 @@ lazy val root = (project in file(".")).
|
||||
"org.apache.commons" % "commons-lang3" % "3.18.0",
|
||||
"jakarta.ws.rs" % "jakarta.ws.rs-api" % "2.1.6",
|
||||
{{#openApiNullable}}
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.8",
|
||||
"org.openapitools" % "jackson-databind-nullable" % "0.2.9",
|
||||
{{/openApiNullable}}
|
||||
{{#withAWSV4Signature}}
|
||||
"software.amazon.awssdk" % "auth" % "2.20.157",
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user