|
1 | | -[![][badge-license]][generatr-license] |
| 1 | +[![][badge-license]][oap-license] |
2 | 2 | [![][badge-ci]][workflow-ci] |
3 | 3 |
|
4 | | -# openapi-generatr-json |
| 4 | + |
5 | 5 |
|
6 | | -a simple [OpenAPI][openapi] yaml to json generatr. |
7 | | - |
8 | 6 |
|
9 | | -# Getting Started |
| 7 | +# openapi-processor-json |
10 | 8 |
|
11 | | -The openapi generatr [gradle plugin][generatr-gradle] is the easiest way to use yaml to json generatr. |
| 9 | +a simple [OpenAPI][openapi] yaml to json converter. |
| 10 | + |
12 | 11 |
|
13 | | -## adding generatr-json |
| 12 | +# Getting Started |
14 | 13 |
|
15 | | -The plugin provides a `openapiGeneratr` dependency configuration that is used to add the generatr dependency. |
| 14 | +The openapi processor [gradle plugin][opa-gradle] is the easiest way to use the yaml to json processor. |
16 | 15 |
|
17 | | - dependencies { |
18 | | - // 'openapiGeneratr' is a custom configuration that is used by the gradle plugin. |
19 | | - openapiGeneratr 'com.github.hauner.openapi:openapi-generatr-json:1.0.0.M1' |
20 | | - |
21 | | - // .... |
22 | | - // normal project dependencies |
23 | | - // .... |
24 | | - } |
25 | | - |
26 | | -## configuring generatr-json |
| 16 | +## configuring openapi-processor-json |
27 | 17 |
|
28 | | -The plugin will add an `openapiGeneratr` configuration block that is used to configure the generatrs. |
29 | | -Configuration for a specific generatr is placed inside it using the generatr name as configuration |
30 | | -block name. |
| 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. |
31 | 21 |
|
32 | | - openapiGeneratr { |
| 22 | + openapiProcessor { |
33 | 23 |
|
34 | 24 | json { |
| 25 | + processor 'com.github.hauner.openapi:openapi-processor-json:1.0.0.Mx' |
| 26 | + |
35 | 27 | apiPath = "$projectDir/src/api/openapi.yaml" |
36 | 28 | targetDir = "$projectDir/build/openapi" |
37 | 29 | } |
38 | 30 |
|
39 | 31 | } |
40 | 32 | |
41 | | -- `apiPath`: (**required**) the path to the `openapi.yaml` file and the main input for the generatr. |
| 33 | +- `apiPath`: (**required**) the path to the `openapi.yaml` file and the main input for the processor. |
42 | 34 |
|
43 | 35 | - `targetDir`: (**required**) the output folder for generating the `openapi.json` file. |
44 | 36 |
|
45 | 37 | # Sample |
46 | 38 |
|
47 | | -See [`openapi-generatr-spring-mvc-sample`][generatr-sample] for a complete working sample of a minimal |
48 | | - openapi.yaml. |
| 39 | +See [`openapi-processor-spring-mvc-sample`][oap-sample] for a complete working sample of a minimal openapi.yaml. |
49 | 40 |
|
50 | 41 |
|
51 | 42 | [badge-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42 |
52 | | -[badge-ci]: https://github.com/hauner/openapi-generatr-json/workflows/ci/badge.svg |
| 43 | +[badge-ci]: https://github.com/hauner/openapi-processor-json/workflows/ci/badge.svg |
53 | 44 |
|
54 | | -[workflow-ci]: https://github.com/hauner/openapi-generatr-json/actions?query=workflow%3Aci |
| 45 | +[workflow-ci]: https://github.com/hauner/openapi-processor-json/actions?query=workflow%3Aci |
55 | 46 |
|
56 | 47 | [openapi]: https://www.openapis.org/ |
57 | 48 |
|
58 | | -[generatr-license]: https://github.com/hauner/openapi-generatr-json/blob/master/LICENSE |
59 | | -[generatr-gradle]: https://github.com/hauner/openapi-generatr-gradle |
60 | | -[generatr-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample |
| 49 | +[oap-license]: https://github.com/hauner/openapi-processor-json/blob/master/LICENSE |
| 50 | +[oap-gradle]: https://github.com/hauner/openapi-processor-gradle |
| 51 | +[oap-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample |
0 commit comments