File tree Expand file tree Collapse file tree 1 file changed +10
-2
lines changed
Expand file tree Collapse file tree 1 file changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -17,8 +17,16 @@ link:{oaps-license}[image:{badge-license}[]]
1717*openapi-processor-spring* is an link:{openapi}[OpenAPI] interface & model only java code generator
1818for link:{springboot}[Spring Boot].
1919
20- It supports an API first approach where you API is explicitly defined and documented with OpenAPI
21- before it gets implemented.
20+ It supports an approach where you explicitly define and document your Service API (using OpenAPI)
21+ with the Interface to the outside and its usage in mind before you implement it. You do not derive
22+ the API later from the implementation and its implicit design. (of course, adapt as you go... )
23+
24+ The advantages are:
25+
26+ * you have a single place to maintain the api which makes it easier to create a consistent api
27+ and keep the overview.
28+ * it is easy to document in plain text. You can use markdown in the OpenAPI `description`
29+ properties.
2230
2331 The processor generates java interfaces based on the endpoint description of the API and simple POJO
2432classes for parameter or response objects defined in the API. The processor adds all the required
You can’t perform that action at this time.
0 commit comments