Skip to content

Commit 0588927

Browse files
committed
updated documentation
1 parent cfd40c9 commit 0588927

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

docs/modules/ROOT/pages/index.adoc

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,41 +21,36 @@ link:{oapj-license}[image:{badge-license}[]]
2121
link:{oap-central}[image:{badge-central}[]]
2222

2323

24-
a simple link:{openapi}[OpenAPI] yaml to json converter. May be useful to feed the OpenAPI to an api viewer like
25-
link:{swagger-ui}[Swagger UI].
24+
a simple link:{openapi}[OpenAPI] YAML to JSON converter. Maybe useful to feed the OpenAPI to an api viewer like link:{swagger-ui}[Swagger UI].
2625

27-
It is reading the OpenAPI document, bundles it, i.e. it merges all external `$ref` s into the main document and writes it as JSON to disk.
26+
It is reading the OpenAPI document, bundles it, i.e., it merges all external `$ref` s into the main document and writes it as JSON to disk.
2827

2928
== Getting Started
3029

31-
The xref:gradle::index.adoc[openapi-processor-gradle] gradle is the easiest way to use the yaml to json processor.
30+
Configuration is identical to the other processors.
3231

33-
== configuring gradle
32+
== Gradle example configuration
3433

35-
The gradle plugin will add an `openapiProcessor` configuration block that is used to configure the openapi processors.
36-
Configuration for a specific processor is going inside it with the processor name (in this case `json`) as the
37-
configuration block name.
34+
The xref:gradle::index.adoc[Gradle plugin] is required to run the processor from a gradle build.
35+
36+
After adding the plugin add an `openapiProcessor` configuration like the one below to the Gradle build file.
3837

3938
[source,groovy]
4039
----
40+
// groovy
4141
openapiProcessor {
42-
4342
json {
44-
processor 'com.github.hauner.openapi:openapi-processor-json:2021.2'
45-
43+
processor 'io.openapiprocessor:openapi-processor-json:2026.1'
4644
apiPath = "$projectDir/src/api/openapi.yaml"
4745
targetDir = "$projectDir/build/openapi"
4846
}
49-
5047
}
5148
----
5249

5350
- `apiPath`: (**required**) the path to the `openapi.yaml` file and the main input for the processor.
5451

5552
- `targetDir`: (**required**) the output folder for generating the `openapi.json` file.
5653

57-
== Samples
54+
== Sample
5855

59-
See xref:samples:ROOT:spring-mvc.adoc[spring mvc sample] or
60-
xref:samples:ROOT:spring-webflux.adoc[spring webflux sample] for a complete working spring boot sample with a
61-
minimal openapi.yaml.
56+
See the link:https://github.com/openapi-processor/openapi-processor-samples/tree/master/samples/spring-mvc-boot-4-packages-kt[spring-mvc-boot-4-packages-kt] samle project.

0 commit comments

Comments
 (0)