Files
openapi-generator/modules/openapi-generator-online
Philzen 2b9949a66b Bump Jackson to latest v2.17.1 and sync in templates (#18799)
* Drop separate version property

Not required as all Jackson packages usually tether on a version bump.

* Update Jackson to v2.17.1

* Sync Jackson version used by Spring Boot with project version

* Sync jackson update to v2.17.1 with generator templates

* Regenerate samples with updated versions

* Adjust test to current exception msg behavior

* Add dependency mgmt to ensure matching version for transitive dependencies

* Update library descriptions with correct Jackson version number

* Update library descriptions with correct GSON and JSONB versions

* Update retrofit library description with correct version number

* Update retrofit description to include Jackson as an option

This should have been done as part of in #16853.

* Update remaining libary version descriptions with correct versions

* Generate updated doc
2024-06-02 15:17:38 +08:00
..
2024-06-01 16:40:40 +08:00
2024-04-17 19:05:37 +08:00

OpenAPI generated server

A Spring Boot Server application which hosts a client/server generator API.

Overview

This server was generated by the OpenAPI Generator project. By using the OpenAPI-Spec, you can easily generate a server stub or one of 100+ client packages.

This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.

The underlying library integrating OpenAPI to SpringBoot is springfox

Building

Refer to root README for build directions.

Running

Via command line

Running is as simple as:

java -jar ./target/openapi-generator-online.jar

This exposes the API on local port 8080.

Springfox supports configuration of the "host" value in the output OpenAPI document by setting the Host HTTP header in the request. To set this explicitly, pass the system property springfox.documentation.swagger.v2.host with the desired host. For example:

java -Dspringfox.documentation.swagger.v2.host=example.com:8888 -jar ./target/openapi-generator-online.jar

Via Docker

After building from source, change to this module directory (cd modules/openapi-generator-online) and build the docker image:

docker build -t openapitools/openapi-generator-online:latest .

Now, run the docker image:

docker run -d -p 8888:8080 openapitools/openapi-generator-online

The GENERATOR_HOST variable is used here to ensure download links generated by the API refer to the proper API location.

Environment

GENERATOR_HOST can be set to force the scheme/host/port used for download link generation. In most cases, this environment variable is not necessary to be set and the download link will be generated to match the originating request. The variable is provided simply as a fallback.