forked from loafle/openapi-generator-original
032e1a42d6
* remove @RequestMapping from the apiController.mustache file and add it to the api.mustache file * move the defaultBasePath.mustache file in src/main/resources/JavaSpring so that it commun with all Spring server-side libraries (spring-boot, spring-mvc). The value of default context path is the value of contextPath variable. * added a unit test to verify it * update the outputDir variable to samples/server/petstore/spring-stubs in the bin/configs/spring-stubs.yaml file because it generates Spring server-side classes. And not on the client-side as the output directory seemed to suggest. * Results of "generate-samples.sh bin/configs/spring*" command * Remove default value of url in @FeignClient * resolve conflicts with origin/master * merge remote/master into branch * fix samples after a merge with master * delete the directory samples/client/petstore/spring-stubs because it moved to samples/openapi3/... * add samples/client/petstore/spring-stubs just for the CI build (normally it is unnecessary)) * delete 3 kotlin class files commited by error in samples/server/petstore/kotlin-springboot and samples/server/petstore/kotlin-springboot-reactive * Update the unit test SpringCodegenTest.doAnnotateDatesOnModelParameters because one more annotation is generated (@RequestMapping) Co-authored-by: rpruvost <rpruvost@ITEM-S78402.emea.msad.sopra> Co-authored-by: rpruvost <rpruvost@ITEM-S78402> Co-authored-by: rpruvost <rpruvost>
28 lines
913 B
Markdown
28 lines
913 B
Markdown
|
|
# OpenAPI generated API stub
|
|
|
|
Spring Framework stub
|
|
|
|
|
|
## Overview
|
|
This code was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
|
|
By using the [OpenAPI-Spec](https://openapis.org), 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 {
|
|
|
|
}
|
|
```
|