Skip to content

Commit 7b73835

Browse files
committed
updated README
1 parent b53b76b commit 7b73835

File tree

1 file changed

+3
-26
lines changed

1 file changed

+3
-26
lines changed

README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,4 @@
1+
# API first Spring Boot Service (WIP)
12

2-
# OpenAPI generated API stub
3-
4-
Spring Framework stub
5-
6-
7-
## Overview
8-
This code was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
9-
By using the [OpenAPI-Spec](https://openapis.org), you can easily generate an API stub.
10-
This is an example of building API stub interfaces in Java using the Spring framework.
11-
12-
The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
13-
by adding ```@Controller``` classes that implement the interface. Eg:
14-
```java
15-
@Controller
16-
public class PetController implements PetApi {
17-
// implement all PetApi methods
18-
}
19-
```
20-
21-
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:
22-
```java
23-
@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
24-
public interface PetClient extends PetApi {
25-
26-
}
27-
```
3+
This Spring Boot Service will be created by the API first approach and tested with [Karate](https://intuit.github.io/karate/). Due to missing capability of OpenAPI Generator in Version 5.0.0 the direct download of the API spec is not possible at the moment. So we will rely on using [Gradle Download Task](https://github.com/michel-kraemer/gradle-download-task). There is also already a [bug report](https://github.com/OpenAPITools/openapi-generator/issues/8255) written by [joschi](https://github.com/joschi). And there is an open [feature request](https://github.com/OpenAPITools/openapi-generator/issues/9083) for OpenAPI Generator to support OpenAPI Spec 3.1.
4+
During the writing process OpenAPI Generator was removed and replaced [OpenAPI Processor](https://docs.openapiprocessor.io/oap/home/home.html).

0 commit comments

Comments
 (0)