Skip to content

Commit ef9e26b

Browse files
committed
improve text
1 parent 284aded commit ef9e26b

1 file changed

Lines changed: 6 additions & 17 deletions

File tree

docs/modules/ROOT/pages/index.adoc

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ link:{oaps-license}[image:{badge-license}[]]
1414
link:{oap-central}[image:{badge-central}[]]
1515

1616

17-
*openapi-processor-spring* is an link:{openapi}[OpenAPI] interface & model java code generator
17+
*openapi-processor-spring* is an link:{openapi}[OpenAPI] interface & dto java code generator
1818
for link:{springboot}[Spring Boot].
1919

2020
It supports an approach where you explicitly define and document your Service API (using OpenAPI)
@@ -28,10 +28,7 @@ and keep the overview.
2828
* it is easy to document in plain text. You can use markdown in the OpenAPI `description`
2929
properties.
3030
31-
The processor generates java interfaces based on the endpoint description of the API and simple POJO
32-
classes for parameter or response objects defined in the API. The processor adds all the required
33-
spring & jackson annotations to the interface and all that is left to *you* is the implementation
34-
of the generated interfaces in any way you like.
31+
The processor generates java interfaces based on the endpoint description of the API and simple POJO classes or records for parameter or response schemas defined in the API. The processor adds all the required spring & jackson annotations to the interface and all that is left to *you* is the implementation of the generated interfaces in any way you like.
3532

3633
The interfaces will help to keep the implementation in sync with the API. If anything relevant
3734
changes in the API the interface changes and the compiler will warn that the interface is not
@@ -48,23 +45,15 @@ out some samples, or your own yaml and view the code that the processor generate
4845

4946
== Features
5047

51-
- generates **only java interfaces and java model classes** (get/set POJOs) for all defined endpoints
52-
and schemas to allow full control of the endpoint implementation. It does not generate any other
53-
file. See xref:processor/index.adoc[processor].
48+
- generates **only java interfaces and java dto classes** (get/set POJOs or records) for all defined endpoints and schemas to allow full control of the endpoint implementation. It does not generate any other file. See xref:processor/index.adoc[processor].
5449

55-
- **powerful type mappings with generic support** (one level) to map schemas defined in the openapi.yaml
56-
to existing java types.
50+
- **powerful type mappings with generic support** to map schemas defined in the openapi.yaml to existing java types.
5751
+
58-
For example to map the openapi `array` type to a different java collections or to map paging
59-
parameters and results to th Spring types like `Page<>` & `Pageable`.
52+
For example to map the openapi `array` type to a different java collections or to map paging parameters and results to th Spring types like `Page<>` & `Pageable`.
6053
+
6154
mappings can be defined globally, for a specific response, parameter or endpoint and or http method (of an endpoint). See xref:mapping/index.adoc[type mapping].
6255

63-
- Annotation based **WebFlux support**. Actually there is *no* explicit WebFlux support, but the mapping
64-
allows defining a *single*, and a *multi* wrapper class. *single* wraps non-array like result types
65-
(e.g. `Mono<>`). *multi* replaces array like result types or parameters with the given multi mapping.
66-
For example, it will replace `List<String>` with `Flux<String>` if the multi mapping contains the
67-
fully qualified `Flux` type. +
56+
- Annotation based **WebFlux support**. Actually there is *no* explicit WebFlux support, but the mapping allows defining a *single*, and a *multi* wrapper class. *single* wraps non-array like result types(e.g. `Mono<>`). *multi* replaces array like result types or parameters with the given multi mapping. For example, it will replace `List<String>` with `Flux<String>` if the multi mapping contains the fully qualified `Flux` type. +
6857
//[.badge .badge-since]+since 1.0.0.M13+
6958

7059
- generates **human-readable code**.

0 commit comments

Comments
 (0)