forked from OpenAPITools/openapi-generator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[online] Revert GENERATOR_HOST explicit setting (OpenAPITools#3287)
- Loading branch information
1 parent
109808e
commit 45da167
Showing
3 changed files
with
47 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,54 @@ | ||
# OpenAPI generated server | ||
|
||
Spring Boot Server | ||
A Spring Boot Server application which hosts a client/server generator API. | ||
|
||
|
||
## Overview | ||
|
||
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. | ||
By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub. | ||
By using the [OpenAPI-Spec](https://openapis.org), 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](https://github.com/springfox/springfox) | ||
|
||
Start your server as a simple java application | ||
## Building | ||
|
||
Refer to [root README](../../README.md) 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 \ | ||
-e GENERATOR_HOST=http://localhost:8888 \ | ||
openapitools/openapi-generator-online | ||
``` | ||
|
||
Change default port value in application.properties | ||
The `GENERATOR_HOST` variable is used here to ensure download links generated by the API refer to the proper API location. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters