forked from loafle/openapi-generator-original
e626b43e27
* Added the useResponseEntity additional parameter for Spring generator * Changed the mustache templates using the new useResponseEntity property * Added the new property to the documentation * Merging with remote master * #11537 Added missing configuration for the delegate pattern case * #11537 Added autogenerated @ResponseStatus on Spring methods * #11537 Fixed borsch comments * #11537 Added the default 200 HTTP Status for empty response HTTP code * [Java][Spring] useResponseEntity sample + remove blank line * [Java][Spring] useResponseEntity sample + remove blank line * [Java][Spring] useResponseEntity sample + remove blank line --------- Co-authored-by: Oleh Kurpiak <oleh.kurpiak@gmail.com>
27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
# OpenAPI generated server
|
|
|
|
Spring Boot Server
|
|
|
|
## 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.
|
|
This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.
|
|
|
|
The underlying library integrating OpenAPI to Spring Boot is [springfox](https://github.com/springfox/springfox).
|
|
Springfox will generate an OpenAPI v2 (fka Swagger RESTful API Documentation Specification) specification based on the
|
|
generated Controller and Model classes. The specification is available to download using the following url:
|
|
http://localhost:8080/v2/api-docs/
|
|
|
|
**HEADS-UP**: Springfox is deprecated for removal in version 6.0.0 of openapi-generator. The project seems to be no longer
|
|
maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is
|
|
supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is,
|
|
as an added bonus, OpenAPI v3 compatible.
|
|
|
|
|
|
|
|
Start your server as a simple java application
|
|
|
|
You can view the api documentation in swagger-ui by pointing to
|
|
http://localhost:8080/swagger-ui.html
|
|
|
|
Change default port value in application.properties |