loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

update README

Browse Source
This commit is contained in:
cbornet 2016-06-03 15:37:06 +02:00
parent fe8b0cf07b
commit 3b37584c1f
3 changed files with 51 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
modules/swagger-codegen/src/main/resources/JavaSpringBoot/README.mustache
View File

@ -1,4 +1,4 @@
# Swagger generated server {{^interfaceOnly}}# Swagger generated server
Spring Boot Server Spring Boot Server
@ -15,4 +15,31 @@ Start your server as an simple java application
You can view the api documentation in swagger-ui by pointing to You can view the api documentation in swagger-ui by pointing to
http://localhost:8080/ http://localhost:8080/
Change default port value in application.properties 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}}

33
samples/client/petstore/spring-stubs/README.md
View File

@ -1,18 +1,27 @@
# Swagger generated server
Spring Boot Server # Swagger generated API stub
Spring Framework stub
## Overview ## Overview
This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. 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 a server stub. 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 a swagger-enabled server in Java using the SpringBoot framework. This is an example of building API stub interfaces in Java using the Spring framework.
The underlying library integrating swagger to SpringBoot is [springfox](https://github.com/springfox/springfox) 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
}
```
Start your server as an simple java application 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 {
You can view the api documentation in swagger-ui by pointing to }
http://localhost:8080/ ```
Change default port value in application.properties

2
samples/server/petstore/springboot/README.md
View File

@ -15,4 +15,4 @@ Start your server as an simple java application
You can view the api documentation in swagger-ui by pointing to You can view the api documentation in swagger-ui by pointing to
http://localhost:8080/ http://localhost:8080/
Change default port value in application.properties Change default port value in application.properties