This utility class has been marked as deprecated for future removal since Spring 6.0.5. All Java generators, except WebClient and RestTemplate, are already using Base64 directly.
* add github work for erlang projects
* trigger build
* use setup-bean instead
* add rebar3 version
* update otp version
* fix otp version
* fix otp version
* use 22.2
* fix
* fix
* fix ubuntu version
* use 22.2
* comment out erlang server test
* add from_dict to model_anyof template in python-nextgen, fixes#14767
* add space before from_dict in model.anyof in python-nextgen
* update samples, add tests
---------
Co-authored-by: Tomas Karasek <tom.to.the.k@gmail.com>
* Fix serialization when there is a discriminator with mapping
* Update samples
* Update samples
* upgrade samples
* Revert "Update samples"
This reverts commit d6affde263.
* [dart] Cleanup unused/redundant stuff
* [dart] Bump Dio to 5.0.0
* Fix description
* Get tests to run based with git dependency
* Fix test generation
* Update docs
* Update test dependencies
* Use released version of http_mock_adapter
* [Kotlin-Spring] Support multiline descriptions
This commit adds support for multiline descriptions for operations in
the Kotlin-Spring generator, for both regular API generation (i.e.
Controller), as well as interface-only API generation.
Multiline descriptions allow us to use rich text representations, e.g.
with Markdown. Note that Markdown-formatted descriptions are rendered
nicely in Swagger-UI. I imagine that most openapi consumers will be able
(or will want to) support Markdown (at some point).
The solution for Kotlin-Spring is rather simple, using Raw Strings to
contain the `unescapedNotes`.
See: https://kotlinlang.org/docs/strings.html#raw-strings
Note that specific unescaped strings could cause problems. For example,
the string containing three double quotes `"""` would result in compile
errors for the generated code. I think this is acceptable.
Note that an improvement is possible to use `.trimMargin()` in
combination with the pipe symbol `|`, to allow specific margin
prefixing.
Note that the description is used in escaped form in the JavaDoc. This
could be resolved by prefixing every line of the unescapedNotes with a
star `*`.
For now, I've chosen to implement this the simplest way I could think
off.
Signed-off-by: Nico Korthout <nico.korthout@camunda.com>
* [Kotlin-Spring] Update samples
Signed-off-by: Nico Korthout <nico.korthout@camunda.com>
---------
Signed-off-by: Nico Korthout <nico.korthout@camunda.com>
* Remove dead code
* Refactor containsKey before get
* Minor refactor
* Use JsonMapper.builder() to build ObjectMapper
Fix a bug where ALLOW_COERCION_OF_SCALARS wasn't set properly.
* Update samples
* Oops, fix a typo
* io/ioutil has been deprecated ass of Go 1.16, the same functionality is now provided by package io or package os
* run pr checklist
* Bump go version to 1.16.
* Run pr checklist
* Bump version to 1.18
* Run pr check list
* allow general purpose faraday connection configuration
* add spec for Configuration#configure_faraday_connection
* run generators
* limit changes to ruby client generated using faraday library
* [Kotlin] add spring boot 3 & jakarta extension support
* [kotlin-spring] readme update & modified imports
* use latest Spring Boot starter parent
* use same options as in [Java] generator
* new config kotlin-spring-boot-3
---------
Co-authored-by: jayandran sampath <jayandran.sampath@opencastsoftware.com>
* Dummy client generated
* Adding dummy versions, my IDE crashed
* Making my first actual requests
* Creates first version of API Generator for Jetbrains Client
* Adds generated API files
* Adds more complex API definition
* Adds basic supporting files
* Adds empty environment file for variables
* Adds basic README
* Adds minimal set of values in env file`
* Adds minimal support for API Key header
* Adds Adyen API sample
* Add null checks on code
* Simplifies the generator, cleans output
* Improves README
* Fix minor issues with README
* Removes API file and config used for local testing
* Remove leftover logging file
* Disables tests as I find how to write them
* Sets generator as experimental
* Add new generator language enum value
* Adds generator doc file
* Adds generators main file
* Removes unused method. Adds my name
* Adding Jetbrains HTTP Client to the README
* Added a Julia client and server
This PR adds two new generators for the [Julia language](https://julialang.org/)
- `julia-client` to generate a client from specifications
- `julia-server` to generate a server with stubs that can be used to host a server conforming to the specifications
The generated code uses the Julia [OpenAPI.jl](https://github.com/JuliaComputing/OpenAPI.jl) package that includes support functions for both client and server.
* fix javadoc generation
* add changes after ensure-up-to-date run
* [python-nextgen] fix template to make auto-generated example runnable when spec has no auth methods
* update samples with ./bin/generate-samples.sh
* add unit test code
* [REQ] Add equals and hashcode to java-cxf pojo #12519
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* [Java] Use abstraction for files for jaxrs-cxf #8792
* fix sample
* fix sample
---------
Co-authored-by: FWermelskirchen <fwermelskirchen@eitco.de>
* [java] Fix template logic related to supportUrlQuery
Generated models for arrays marked with uniqueItems: true (which end up as a Set<> in java) won't
compile because the templates are in some places using .get(i) on the sets.
Also, when the supportUrlQuery property is present in the additionalProperties map the
resulting value will be read using the key SUPPORT_STREAMING instead of 'supportUrlQuery'.
* fix NPE
Co-authored-by: Björgvin <bjorgvino@gmail.com>
* Currently, if a Model is an allOf the time and os imports are not correctly added to the generated file. This was introduced recently with a fix to not include those imports when the model is a composedSchema #13833. The logic in that fix was just slightly off as an allOf should be treated the same as a standard model.
If a model is an AllOf or does not have any composed schemas at all, the sub-models are in-lined defined in the struct. In this case, the standard logic of including the time and os imports apply.
If a model is a OneOf or AnyOf, the sub-models are included as pointers to the defined model. In this case, do not include those items in the logic of including time and os imports.
* Update example to include a time in an allOf
* Add back the accidentally removed nil check
* Use correct Pascal case for java enum
* Uniquely name @Bean annotations
* Use existing mustache var instead, run generate files
* rebase, re-run generators
* try to undo botched rebase/merge
* Attempt to manually undo whatever is going on w/ build, oops
* Attempt to manually undo whatever is going on w/ build, oops
* Change the return type of a file back to a pointer
* Change the api template to handle not double pointer-ing return types of os.File
* Fix unit tests
* Couple more unit test fixes
* fix depricated @Schema(required) since swagger 2.2.5
* use same swagger-annotations version which is used by swagger-core which is a dependency of springdoc
* generated java sampes
* If the collection type is csv, that means 'dont explode the query params'.
* Simplify the logic just a tad
* url.Values -> Has was added in go1.17 but there are CI tests running at 1.16
* [kotlin][client] add info if endpoints requires authentication or not
* [kotlin][client] update sample projects
* [kotlin][client] add info if endpoints requires authentication or not
* [kotlin][client] update sample projects
* add workflow to test java apache client with jdk8
* fix url encode issue with jdk8
* update samples
* minor improvements in java native client
* minor fix
* Added additional documentation for configuration object
* Regenerate samples
* Added exemplary usage of API to README.md
* Updated README, refined wording
* Added example for calling the API
* Regenerated samples
* Updated samples
* Add async `execute` interface
* Update samples
Run `./bin/generate-samples.sh`
* Add an explicit `self`
I forgot to add it
* Add an availability condition
* Add support of AWSV4 Signature in Java
* Add Petstore sample for AWSV4 Signature
* Update other sample examples
* Sync Documentation and sample
* Specify only available for okhttp-gson in doc
* #14141 Add externalDocs to @Operation to the JavaSpring generator
* #14141 Add externalDocs to @Operation to the JavaSpring generator : fix mustache template with #hasExternalDocs
* #14141 Add externalDocs to @Operation to the JavaSpring generator: fix indentation
* #14141 Add externalDocs to @Operation to the JavaSpring generator: fix carriage return
* #14141 Add externalDocs to @Operation to the JavaSpring generator: regenerate the spring-boot-oas3.yaml sample
* #14141 Add externalDocs to @Operation to the JavaSpring generator: generate-samples.sh
* #14141 Add externalDocs to @Operation to the JavaSpring generator: remove hasExternalDocs
* Fix ExternalDocumentation import generation and order
* #14141 Add externalDocs to @Operation to the JavaSpring generator: generate-samples.sh
* Fix#14276 Java Templates uses jakarta or javax package if useJakartaEe
is true
* generated samples after useJakartaEe changes
* generated docs after useJakartaEe changes
* Fix swapped operators
Signed-off-by: Tom Hörberg <tom@hoerberg.de>
* add conversion to support non-string params
Signed-off-by: Tom Hörberg <tom@hoerberg.de>
* Provide better fix for nonstring url param values
Signed-off-by: Tom Hörberg <tom@hoerberg.de>
* Updated python-nextgen sample files
Signed-off-by: Tom Hörberg <tom@hoerberg.de>
Signed-off-by: Tom Hörberg <tom@hoerberg.de>
* update openapi-generator dep
* update dep, fix tests with new spec
* update kotlin version
* revert cafferine version
* add back testng version and scope
* [rust] Fix declaration for arrays with object and array references
For arrays with an item defined by reference to an array or an object,
the generated type declaration was `Vec<core::models::Array>` or
`Vec<core::models::Map>` without defining a `Array` or `Map` so that the
code didn't compile.
* [rust] Fix trailing whitespace in petstore definition
When sending a request with a client generated by typescript-nestjs, the
default headers are modified. This occurs when headers such as "Accept"
are appended by the client.
The root of the issue is that a reference to the default headers is
stored instead of a clone.
* Enable the ruby client to support refreshing access tokens
- The client can now be configured with an access token getter proc
- The proc overrides the the static access token if it is set
* Run generators
* Update Java/Feign api.mustache to accept convinience Map
Hi, I just saw, that the generated Map Class is never used outside of tests, but it would be the perfect fit for the changed mehods, as its use-case is exactly the same.
Also a useful change to prevent problems with Collection types and their generics parameters (f.e. Map<x, y>). See: https://stackoverflow.com/questions/62823341/openapi-generator-maven-plugin-breaks-old-feign-with-querymap
* PR checklist
Steps as requested per checklist: done.
* Supporting Gson decoder in Feign
* Supporting Gson decoder in Feign
* Fixing test failures - and ensuring Jackson is used as the default if nothing selected (back compatible)
* Adding in sample files
* Updating docs
* Switching to echo server version
* Adding feign-gson to the github workflow
* Empty-Commit
* Add support for Angular v15
Support for:
- rxjs 7.5.5
- ngPackagr 15.0.2
- zonejs 0.11.5
- typescript >=4.8.2 and <4.10.0
Note that tsTickle is not added to the dependencies when generating for
Angular 15, as:
- it is not a real dependency
- tsTickle is compatible with any of the TypeScript versions that
Angular 15 supports.
* Generate samples for Angular v15
- typescript-angular-v15-provided-in-root
- typescript-angular-v15-query-param-object-format
* Drop sample typescript-angular-v15-query-param-object-format
* Fix typo
* Add tests for sample
Use credentials instead of api_key to avoid deprecation warnings when
initialising ConfigurationParameters.
* Update samples/client/petstore/typescript-angular-v15-provided-in-root/package.json
* Fix tests by removing context initialisation
Also updated the test dependencies.
Co-authored-by: Esteban Gehring <esteban.gehring@gmail.com>
* Changes manually cherry-picked (for the most part) from https://github.com/OpenAPITools/openapi-generator/pull/12685/files
* Examples updated post changes
* Missed a change in the mustache template
* Update examples after last fix
* Missed dereference for required files
* Update unit tests
* Missed another test case update
* `f := *f` isn't quite the same as `*f, err = ...`
* Fix response type to be Response or undefined
Current generated code produces a `response` variable set to undefined, and TS does not like you changing the type of the variable later. Therefore, set the type of the variable to be `Response` or `undefined`
Solves OpenAPITools/openapi-generator#12007
* Update samples
* clean up shippable ci related config and files
* comment out closeAndReleaseRepository
* Revert "comment out closeAndReleaseRepository"
This reverts commit 5a76e403b1.
* remove closeAndReleaseRepository
* Upgrade Gradle plugin Gradle build to Gradle 7.5.1
* Update Travis workflow file to support new tasks
* Update Maven POM with Gradle 7.5.1
* Capitalize many occurrences of "Gradle" in the Gradle plugin README
* Update Gradle version in appveyor.yml and shippable.yml
* Update comments
* Update Gradle wrapper to 7.5.1
* Capitalize Gradle in shippable.yml
* Leave Open API
* Upgrade Gradle plugin build to Gradle 7.6
* Upgrade wrapper to Gradle 7.6
* multiple use of parameters in deepobjects
* fix java native
* support camelCase
* revert modifying baseName because it is not used anymore
* remove commented line
When fromOperation(...) was called before fromModel, the aliases were uninitialized.
(cherry picked from commit 44ea23168362cfacf8a61ff944701990cf3fea76)
Co-authored-by: Clemens Heppner <ch@wps.de>
* fix documentation
* improve build.gradle.mustache and pom.xml.mustache to assume different serialization libs jackson or micronaut-serde-jackson
* improve pojo.mustache to skip generating @JsonDeserialize as for micronaut-serde-jackson
* improve model generating by removing visible flag from @JsonTypeInfo as it is not supported by micronaut-serde-jackson
Co-authored-by: dmitry.kubakhov <dmitry.kubakhov@check24.de>
This change has no functional impact. In my view, `pathlib` has a more
pleasant API than `os.path`. Incidentally, this slightly reduces line
count.
cc @spacether
* modify Alamofire version in podspec
* modify Alamofire version in Package.swift
* also pin optimistically in Cartfile
* optimistically resolve all other dependencies to next major version
* Add args to reserved words
* arg and args to _arg and _args in templates
* Corrections
* Test added
* Corrections
* Use arg and args as defined properties
* Removed unnecessary assertion
* Suggested change
* add isEnumRef to codegen property
* better format
* update R template to use isEnumOrRef
* update powershell template to use isEnumOrRef
* update samples
The if not passed the models create a new configuration object which
configures logging and determines cpu count every time.
This causes extreme performance issues when deserializing larger sets of
items.
See also
https://github.com/kubernetes-client/python/issues/1921
* use replace instead of replaceAll
* avoid using instance to accessd static methods
* use entrySet instead of keySet
* use statis class instead of instance for static method
* update samples
Added Twilio to "Companies/Projects using OpenAPI Generator"
https://github.com/twilio/twilio-oai-generator will soon be used to generate all of our helper libraries (currently used for twilio-go)!
* Add modification to petstore yaml to support testing enum string resolve. Move csharp-netcore-net50 to point to new yaml schema.
* [csharp-netcore] - For enum's with an EnumMember Attribute use this value instead of enum.ToString().
-Regenerate csharp samples to accomodate change.
* fix: rebase on master. Update samples.
* task (Samples): update csharp-netcore samples. (via generate-samples.sh)
Updating the OAuth2 client (although obsolete, it's still productive in openapi-generator) due to security problems related to the underlying libraries
* sonatype-2022-3061
* sonatype-2012-0050
Update pom.mustache
* Initial version of Kotlin Vert.x client
* Initial version of Kotlin Vert.x client
* Initial version of Kotlin Vert.x client
* Fix for parseDateToQueryString issue in vert.x kotlin client
* Moved common methods from api to ApiClient in kotlin vert.x client
* Fixed issue with absolute URLs
* bearer auth for oauth
* empty request headers fix
* missing import and typo
* added uri template dependency
* added api abstractions to client generator
* added full import form infrastructure
* removed fail on unknown properties to response body parsing
* fixed error response parsing
* replace vertx client name to more unique
* multiline content type
* optional responses added to template
* additional annotations for kotlin client
* Added additionalModelTypeAnnotations parameter support to AbstractKotlinCodegen
* Updated samples and documents
* Fixed issues with gson and moshi serializers with kotlin-jvm-vertx client
* Added sample configs for kotlin-jvm-vertx clients with gson, jackson and moshi
* Added samples for kotlin-jvm-vertx clients with gson, jackson and moshi
* Included kotlin-jvm-vertx samples to test build
* Updated samples
Co-authored-by: Katja Danilova <katja.danilova@protonmail.com>
* update echo to newer version
* add github workflow
* minor fix
* add install
* go get
* install middleware
* test go api server
* trigger build
* test go-api-server
* Revert "test go api server"
This reverts commit 42f24e578f.
* Revert "Revert "test go api server""
This reverts commit 7ce773275b.
* update samples
* test go gin in github workflow
* go install
* Revert "go install"
This reverts commit ec099b48c1.
* Revert "test go gin in github workflow"
This reverts commit 120516856e.
* remove go api, echo server tests
* fix for issue #13722: send body for application/x-www-form-urlencoded data
* fix python test_application_x_www_form_urlencoded_serialization
* x-www-form-urlencoded data needs to be percent encoded
* add verification endpoint test for x-www-form-urlencoded data
Co-authored-by: David Chaiken <dchaiken@pinterest.com>
* fix html encoded backticks when a modal contains reserved words
* Revert "fix html encoded backticks when a modal contains reserved words"
This reverts commit d2e4d5c780.
* fix html encoded backticks when a modal contains reserved words
* Add cacheability tests for same directory and different directory
(cherry picked from commit 46c96daf3b020ab02e13113166046d2383c04990)
* Clean up/add more cacheability tests
(cherry picked from commit 5d09d914ba7224b82dd7a3bd20beaf2b6fd3eb94)
* Add test for inputSpec
(cherry picked from commit 8d9e0dbb9d865ad3e61b60692b3ef6ca85b70b75)
* Add incremental build tests, run with multiple Gradle versions
(cherry picked from commit ba1d554c375068974d1799d6be6731ca1d59a783)
* Add proper Input annotations to task inputs
(cherry picked from commit 18da6161ba2b406876c516a3059850d9a0bc9ca0)
* Perform clean on tests where expectation is cleaned outputs
(cherry picked from commit 4670db92686c02d5dd2b69976488c33defd3a464)
* Ensure before & after files are the same
(cherry picked from commit 9150b4a5596b229a4404a92cfedbb795c6bb5b0d)
* delete and build samples
* how did this not get committed?
* how did this not get committed?
* how did this not get committed?
* fixed csharp netcore functions
* reverted two files
* restored manually created tests
* reverted some unintentional changes
* restored unintended changes
* Process api_test.mustache
* Create api_test.mustache
* Add test and helper method
* Commit all (re)generated files
* Commit all (re)generated files
* Fix indentation
* Fixing to use equalsNullable when nullable set in config for SpringCodeGen
* Adding additional test case file
* removed print statement from SpringCodeGen
* Updated model object
* Corrected indentation and removed import
* Fixed broken test
* Updating sample
* fix: remove option supportPython2.
[python-flask][python-aiohttp][python-blueplanet]
* fix: update samples
* test only python servers
* fix(tests): downgrade pytest version to ensure compatibility with python3.6 [python-flask][python-aiohttp]
* Revert "fix(tests): downgrade pytest version to ensure compatibility with python3.6 [python-flask][python-aiohttp]"
This reverts commit 9f47db2f87.
* test in circlei
* run commands directly
* test in node 1
* update makefile
* fix Makefile
* fix test
* revert some changes, remove python server tests from travis
Co-authored-by: Kevin Bannier <kevinbannier1@gmail.com>
* generate a RestResourceRoot with a string constant holding the jax-rs resource root to be used in the @ApplicationPath annotation to make it easier for people, who want to write their own jax-rs Application class
* build and update samples as per PR guide
* renamed introduced constant from ROOT to APPLICATION_PATH to make its use more obvious
* JS add oneOf support
* add validate json method
* add oneOf support to JS client
* update samples
* add todo in anyof
* switch to composed.oneOf
* update oneOf to support primitive types
* update messages
* minor fix, add more tests
* update samples
* fix npe in from model
* fix syntax error in length check
* update samples
* restore js tests
* test only js in circleci
* trigger build failure
* Revert "trigger build failure"
This reverts commit 7e8c34e823.
* Revert "test only js in circleci"
This reverts commit e261429339.
* add discriminator property, mapping
* add discriminator, mapping support to R client generator
* add discriminator, mapping support to R client genrator httr library
* fixed data type for maps
* fighting line endings
* fighting line endings
* removed commented code
* reverted unintended line break
* reverted unintended line break
* reverted unintended line break
While working with the Magento 2.4 API definition, there were several
issues found. The easiest to resolve is a documentation naming issue.
(The others will be raised for discussion.)
This is known to be an issue with query parameters, but may not be
limited to *just* query parameters.
In the event that a parameter is a mix of arrays and objects, the
template in the documentation for the API function was expanding out the
parameter name such that `foo[0]` would be turned into
`:foo_left_square_bracket0_right_square_bracket`, but the actual
parameter name was being left as `:foo[0]`, which meant that the
documentation did not reflect the actual parameter.
> Note: there are issues with the way that query parameters are put
> together in this sense, which is going to require substantially more
> work to resolve as well as discussion on how these options should be
> implemented, as what the Magento API requires may not be what is
> expected by a different server, and the nature of the input parameters
> is itself incorrect.
* [PHP] Bugfix - model_generic.mustache: missing setter for openAPINullabelsSetToNull (which is invoked in the property setters)
* [AUTOGENERATED] update samples
* [PHP] Added test for nullable fields
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example `./bin/generate-samples.sh bin/configs/java*`.
For Windows users, please run the script in [Git BASH](https://gitforwindows.org/).
- [ ] File the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master` (6.1.0) (minor release - breaking changes with fallbacks), `7.0.x` (breaking changes without fallbacks)
- [ ] In case you are adding a new generator, run the following additional script :
```
./bin/utils/ensure-up-to-date.sh
```
Commit all changed files.
- [ ] File the PR against the [correct branch](https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): `master` (6.3.0) (minor release - breaking changes with fallbacks), `7.0.x` (breaking changes without fallbacks)
- [ ] If your PR is targeting a particular programming language, @mention the [technical committee](https://github.com/openapitools/openapi-generator/#62---openapi-generator-technical-committee) members, so they are more likely to review the pull request.
[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.openapitools%22%20AND%20a%3A%22openapi-generator%22) [](./LICENSE) [](https://opencollective.com/openapi_generator) [](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g) [](https://twitter.com/oas_generator) [](https://gitpod.io/#https://github.com/OpenAPITools/openapi-generator)
[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.openapitools%22%20AND%20a%3A%22openapi-generator%22)
[](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g)
[](https://twitter.com/oas_generator)
[](https://gitpod.io/#https://github.com/OpenAPITools/openapi-generator)
[](https://github.com/OpenAPITools/openapi-generator/actions?query=workflow%3A%22Check+Supported+Java+Versions%22)
#### Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS and Checkly for sponsoring the API monitoring
@@ -68,13 +76,13 @@ If you find OpenAPI Generator useful for work, please consider asking your compa
## Overview
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification) (both 2.0 and 3.0 are supported). Currently, the following languages/frameworks are supported:
| 7.0.0 (upcoming major release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.0.0-SNAPSHOT/) | Feb/Mar 2023 | Major release with breaking changes (no fallback) |
| 6.2.0 (upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/6.2.0-SNAPSHOT/) | 11.11.2022 | Minor release with breaking changes (with fallback) |
For old releases, please refer to the [**Release**](https://github.com/OpenAPITools/openapi-generator/releases) page.
For decomissioned generators/libraries/frameworks, please refer to [the "Decommission" label](https://github.com/OpenAPITools/openapi-generator/issues?q=label%3ADecommission+is%3Amerged+) in the pull request page.
## [1.2 - Artifacts on Maven Central](#table-of-contents)
You can find our released artifacts on maven central:
@@ -173,16 +182,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 8 runtime at a minimum):
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.1.0/openapi-generator-cli-6.1.0.jar`
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.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.
(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/6.1.0/openapi-generator-cli-6.1.0.jar)
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.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`
@@ -583,6 +592,7 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
- [Arduino](https://www.arduino.cc/)
- [b<>com](https://b-com.com/en)
- [百度营销](https://e.baidu.com)
- [Bandwidth](https://dev.bandwidth.com)
- [Banzai Cloud](https://banzaicloud.com)
- [BIMData.io](https://bimdata.io)
- [Bithost GmbH](https://www.bithost.ch)
@@ -681,6 +691,7 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
- [TribalScale](https://www.tribalscale.com)
- [Trifork](https://trifork.com)
- [TUI InfoTec GmbH](http://www.tui-infotec.com/)
- [Twilio](https://www.twilio.com/)
- [Twitter](https://twitter.com)
- [unblu inc.](https://www.unblu.com/)
- [Veamly](https://www.veamly.com/)
@@ -870,9 +881,20 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
- 2022-07-22 - [使用OpenAPI Generator Maven plugin开发api优先的java客户端和服务端代码](https://blog.roccoshi.top/2022/java/openapi-generator%E7%9A%84%E4%BD%BF%E7%94%A8/) by [Lincest](https://github.com/Lincest)
- 2022-08-01 - [Tutorial: Etsy Open API v3 (ruby)](https://blog.tjoyal.dev/etsy-open-api-v3/) by [Thierry Joyal](https://github.com/tjoyal)
- 2022-09-03 - [OpenAPI Generator For Go Web Development](https://blog.kevinhu.me/2022/09/03/03-openapi-generator/) by [Kevin Hu](https://twitter.com/Oldgunix)
- 2022-10-01 - [OpenAPI Generatorをカスタマイズしたコードを生成する(Swagger Codegenとほぼ同じ)](https://nainaistar.hatenablog.com/entry/2022/10/03/120000) by [きり丸](https://twitter.com/nainaistar)
- 2022-10-21 - [Kotlin(Spring Boot)の API を OpenAPI Generator で自動生成](https://zenn.dev/msksgm/articles/20221021-kotlin-spring-openapi-generator) by [msksgm](https://zenn.dev/msksgm)
- 2022-11-28 - [The REST API implementation flow](https://tmsvr.com/openapi-code-generation-for-rest-apis/) by [Imre Tömösvári](https://tmsvr.com/author/imre/)
- 2022-12-13 - [API-First with Spring WebFlux and OpenAPI Generator](https://boottechnologies-ci.medium.com/api-first-with-spring-webflux-and-openapi-generator-38b7804c4ed4) by [Eric Anicet](https://boottechnologies-ci.medium.com/)
- 2023-01-06 - [Major Improvements with Helidon and OpenAPI](https://medium.com/helidon/major-improvements-with-helidon-and-openapi-f76a0951508e) by [Tim Quinn](https://medium.com/@tquinno600)
- 2023-02-02 - [Replacing Postman with the Jetbrains HTTP Client](https://lengrand.fr/replacing-postman-in-seconds-with-the-jetbrains-http-client/) by [julien Lengrand-Lambert](https://github.com/jlengrand)
## [6 - About Us](#table-of-contents)
What's the design philosophy or principle behind OpenAPI Generator?
We focus on developer experience. The generators should produce code, config, documentation, and more that are easily understandable and consumable by users. We focused on simple use cases to start with (bottom-up approach). Since then the project and the community have grown a lot: 300k weekly downloads via NPM CLI wrapper, 20M downloads via openapi-generator-cli docker image just to highlight a few. We've gradually supported more features (e.g. oneOf, anyOf introduced in OpenAPI 3.0) in various generators and we will continue this approach to deliver something based on our understanding of user demand and what they want, and continue to add support of new features introduced in OpenAPI specification (such as v3.1 and future versions of the OpenAPI specification).
OpenAPI Generator core team members are contributors who have been making significant contributions (review issues, fix bugs, make enhancements, etc) to the project on a regular basis.
@@ -935,12 +957,15 @@ Here is a list of template creators:
gradleProperties:"\n# JVM arguments\norg.gradle.jvmargs=-Xmx2024m -XX:MaxPermSize=512m\n# set timeout\norg.gradle.daemon.idletimeout=3600000\n# show all warnings\norg.gradle.warning.mode=all"
@@ -56,7 +56,7 @@ The above configuration will do the following:
* Compile a user-provided `my_custom_templates/api_interfaces.mustache` following our usual API template compilation logic. That is, one file will be created per API; APIs are generated defined according to tags in your spec documentation. The destination filename of `Interface.kt` will act as a suffix for the filename. So, a tag of `Equipment` will output a corresponding `EquipmentInterface.kt`.
* Because `api.mustache` is the same mustache filename as used in your target generator (`kotlin` in this example), we support the following:
- The destination filename provides a suffix for the generated output. APIs generate per tag in your specification. So, a tag of `Equipment` will output a corresponding `EquipmentImpl.kt`. This option will be used whether `api.mustache` targets a user customized template or a built-in template.
- The built-in template will be used if you haven't provided an customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
- The built-in template will be used if you haven't provided a customized template. The kotlin generator defines the suffix as simply `.kt`, so this scenario would modify only the generated file suffixes according to the previous bullet point.
- Your `api.mustache` will be used if it exists in your custom template directory. For generators with library options, such as `jvm-okhttp3` in the kotlin generator, your file must exist in the same relative location as the embedded template. For kotlin using the `jvm-okhttp3` library option, this file would need to be located at `my_custom_templates/libraries/jvm-okhttp/api.mustache`. See [templating](./templating.md) for more details.
* Compile `my_custom_templates/other/check.mustache` with the supporting files bundle, and output to `scripts/check.sh` in your output directory. Note that we don't currently support setting file flags on output, so scripts such as these will either have to be sourced rather than executed, or have file flags set separately after generation (external to our tooling).
@@ -169,7 +169,7 @@ If you publish your artifact to a distant maven repository, do not forget to add
You may not want to generate *all* models in your project. Likewise, you may want just one or two apis to be written. If that's the case, you can use system properties or [global properties](./global-properties.md) to control the output.
The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
The default is to generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated:
```sh
# generate only models
@@ -397,7 +397,7 @@ or
## Schema Mapping
One can map the schema to someting else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
One can map the schema to something else (e.g. external objects/models outside of the package) using the `schemaMappings` option, e.g. in CLI
Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the `title` field or the `inlineSchemaNameMapping` option, e.g. in CLI
Inline schemas are created as separate schemas automatically and the auto-generated schema name may not look good to everyone. One can customize the name using the `title` field or the `inlineSchemaNameMapping` option. For exmaple, run the following,
[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as arbitraryObjectRequestBodyProperty_request. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).
[main] INFO o.o.codegen.InlineModelResolver - Inline schema created as meta_200_response. To have complete control of the model name, set the `title` field or use the inlineSchemaNameMapping option (--inline-schema-name-mappings in CLI).
```
For example, to name the inline schema `meta_200_response` as `MetaObject`, use the `--inline-schema-name-mappings` option as follows:
Note: Only arrayItemSuffix, mapItemSuffix are supported at the moment.
Note: Only arrayItemSuffix, mapItemSuffix are supported at the moment. `SKIP_SCHEMA_REUSE=true` is a special value to skip reusing inline schemas.
## OpenAPI Normalizer
OpenAPI Normalizer (off by default) transforms the input OpenAPI doc/spec (which may not perfectly conform to the specification) to make it workable with OpenAPI Generator. Here is a list of rules supported:
- `REF_AS_PARENT_IN_ALLOF`: when set to `true`, child schemas in `allOf` is considered a parent if it's a `$ref` (instead of inline schema).
- `REMOVE_ANYOF_ONEOF_AND_KEEP_PROPERTIES_ONLY`: when set to `true`, oneOf/anyOf schema with only required properies only in a schema with properties will be removed. [(example)](modules/openapi-generator/src/test/resources/3_0/removeAnyOfOneOfAndKeepPropertiesOnly_test.yaml)
- `SIMPLIFY_ONEOF_ANYOF`: when set to `true`, simplify oneOf/anyOf by 1) removing null (sub-schema) and setting nullable to true instead, and 2) simplifying oneOf/anyOf with a single sub-schema to just the sub-schema itself.
@@ -27,6 +27,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|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|
|modelNamePrefix|Prefix that will be prepended to all model names.| |OAI|
@@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|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|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|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|
|moduleName|module name (e.g. TwitterClient| |OpenAPIClient|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|shardAuthor|shard author (only one is supported).| |null|
|shardAuthorEmail|shard author email (only one is supported).| |null|
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.