forked from loafle/openapi-generator-original
a7db213c2d
* Upgrade virtualan-plugin to 2.5.1 * Generate samples * Upgrade virtualan sample to springdoc * Generate Samples * Add samples/server/petstore/springboot-virtualan to ci run * Upgrade virtualan-plugin to 2.5.2 * Generate samples * Add virtualan.version to spring-boot-3 pom.xml, upgrade to 2.5.2
30 lines
1.0 KiB
Markdown
30 lines
1.0 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 [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:80/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:80/swagger-ui.html
|
|
|
|
Change default port value in application.properties
|
|
|
|
## Virtualan :
|
|
|
|
You can view Virtualan UI by pointing to
|
|
http://localhost:8080//virtualan-ui.html
|
|
|
|
How to use guide available in the Virtualan wiki
|
|
https://github.com/virtualansoftware/virtualan/wiki
|