forked from loafle/openapi-generator-original
45 lines
1.7 KiB
Plaintext
45 lines
1.7 KiB
Plaintext
{{^interfaceOnly}}# Swagger generated server
|
|
|
|
Spring Boot Server
|
|
|
|
|
|
## Overview
|
|
This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.
|
|
By using the [OpenAPI-Spec](https://github.com/swagger-api/swagger-core), you can easily generate a server stub.
|
|
This is an example of building a swagger-enabled server in Java using the SpringBoot framework.
|
|
|
|
The underlying library integrating swagger to SpringBoot is [springfox](https://github.com/springfox/springfox)
|
|
|
|
Start your server as an simple java application
|
|
|
|
You can view the api documentation in swagger-ui by pointing to
|
|
http://localhost:8080/
|
|
|
|
Change default port value in application.properties{{/interfaceOnly}}{{#interfaceOnly}}
|
|
# Swagger generated API stub
|
|
|
|
Spring Framework stub
|
|
|
|
|
|
## Overview
|
|
This code was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.
|
|
By using the [OpenAPI-Spec](https://github.com/swagger-api/swagger-core), you can easily generate an API stub.
|
|
This is an example of building API stub interfaces in Java using the Spring framework.
|
|
|
|
The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
|
|
by adding ```@Controller``` classes that implement the interface. Eg:
|
|
```java
|
|
@Controller
|
|
public class PetController implements PetApi {
|
|
// implement all PetApi methods
|
|
}
|
|
```
|
|
|
|
You can also use the interface to create [Spring-Cloud Feign clients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).Eg:
|
|
```java
|
|
@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
|
|
public interface PetClient extends PetApi {
|
|
|
|
}
|
|
```
|
|
{{/interfaceOnly}} |