forked from loafle/openapi-generator-original
9f3a73f81a
* addition: api response examples; spring's api.mustache generates response examples * update samples * added 2 sample configs; adsjuted to only generate examples for application/json * added test * remove accidentally added files * small cleanup * add new samples to workflow --------- Co-authored-by: GlobeDaBoarder <glebivashyn@gmail.com> Co-authored-by: William Cheng <wing328hk@gmail.com>
21 lines
850 B
Markdown
21 lines
850 B
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 [springdoc](https://springdoc.org).
|
|
Springdoc will generate an OpenAPI v3 specification based on the generated Controller and Model classes.
|
|
The specification is available to download using the following url:
|
|
http://localhost:8080/v3/api-docs/
|
|
|
|
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 |