Skip to content

Commit 454204c

Browse files
committed
small docs improvement
1 parent 43544b6 commit 454204c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/modules/ROOT/pages/index.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff 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
1818
for 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
2432
classes for parameter or response objects defined in the API. The processor adds all the required

0 commit comments

Comments
 (0)