File tree Expand file tree Collapse file tree 1 file changed +4
-29
lines changed
Expand file tree Collapse file tree 1 file changed +4
-29
lines changed Original file line number Diff line number Diff line change 99a simple [ OpenAPI] [ openapi ] yaml to json converter.
1010
1111
12- # Getting Started
13-
14- The openapi processor [ gradle plugin] [ opa-gradle ] is the easiest way to use the yaml to json processor.
15-
16- ## configuring openapi-processor-json
17-
18- The plugin will add an ` openapiGeneratr ` configuration block that is used to configure the openapi processors.
19- Configuration for a specific processor is placed inside it using the processor name (in this case ` json ` ) as
20- configuration block name.
21-
22- openapiProcessor {
23-
24- json {
25- processor 'com.github.hauner.openapi:openapi-processor-json:1.0.0.Mx'
26-
27- apiPath = "$projectDir/src/api/openapi.yaml"
28- targetDir = "$projectDir/build/openapi"
29- }
30-
31- }
32-
33- - ` apiPath ` : (** required** ) the path to the ` openapi.yaml ` file and the main input for the processor.
34-
35- - ` targetDir ` : (** required** ) the output folder for generating the ` openapi.json ` file.
36-
37- # Sample
38-
39- See [ ` openapi-processor-spring-mvc-sample ` ] [ oap-sample ] for a complete working sample of a minimal openapi.yaml.
12+ # Documentation
4013
14+ See [ here] [ oap-docs ] .
15+
4116
4217[ badge-license ] : https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
4318[ badge-ci ] : https://github.com/hauner/openapi-processor-json/workflows/ci/badge.svg
@@ -46,6 +21,6 @@ See [`openapi-processor-spring-mvc-sample`][oap-sample] for a complete working s
4621
4722[ openapi ] : https://www.openapis.org/
4823
24+ [ oap-docs ] : https://hauner.github.com/openapi-processor/json/current/index.html
4925[ oap-license ] : https://github.com/hauner/openapi-processor-json/blob/master/LICENSE
50- [ oap-gradle ] : https://github.com/hauner/openapi-processor-gradle
5126[ oap-sample ] : https://github.com/hauner/openapi-generatr-spring-mvc-sample
You can’t perform that action at this time.
0 commit comments