File tree Expand file tree Collapse file tree 2 files changed +36
-26
lines changed
Expand file tree Collapse file tree 2 files changed +36
-26
lines changed Original file line number Diff line number Diff line change 11:author: Martin Hauner
22:page-title: openapi-processor-spring
33:page-layout: default
4- :page-aliases: latest@spring:ROOT:index.adoc
4+ // :page-aliases: latest@spring:ROOT:index.adoc
55include::partial$links.adoc[]
66
77//
@@ -101,7 +101,7 @@ artifact name is:
101101
102102.in gradle short notation
103103----
104- com.github.hauner.openapi :openapi-processor-spring:<version>
104+ io.openapiprocessor :openapi-processor-spring:<version>
105105----
106106
107107== Feedback
@@ -110,21 +110,31 @@ In case some feature is missing, or the generated code is not 100% what you woul
110110link:{oaps-issues}[issue]. Preferably with a test case. Providing a test case will help
111111significantly :-)
112112
113- A test case is a single folder with an `openapi.yaml` & `mapping.yaml` file, and the expected Java
114- files the processor should create. The structure looks like this:
115-
116- my-new-test-case/
117- openapi.yaml
118- mapping.yaml
119- generated/
120- api/
121- AnEndpointInterface.java
122- .. more api interfaces ..
123- model/
124- AModelClass.java
125- AnotherModelClass.java
126- .. more model files ..
127-
128- The `mapping.yaml` contains the type mapping information.
113+ A test case is a single folder with two subfolders containing the source files, and the expected output files:
114+
115+ my-test-case
116+ +--- inputs.yaml
117+ |--- inputs
118+ | +--- mapping.yaml
119+ | \--- openapi.yaml
120+ +--- generated.yaml
121+ \--- generated
122+ +--- api
123+ | \--- EndpointApi.java
124+ \--- model
125+ \--- Foo.java
126+
127+ `inputs.yaml` and `generated.yaml` use the same simple format:
128+
129+ items:
130+ - inputs/openapi.yaml
131+ - inputs/mapping.yaml
132+
133+ or
134+
135+ items:
136+ - generated/api/EndpointApi.java
137+ - generated/model/Foo.java
138+
129139
130140See the link:{oaps-inttests}[existing integration tests] for some examples.
Original file line number Diff line number Diff line change 22// external openapi-processor links
33//
44:badge-license: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
5- :badge-ci: https://github.com/hauner /openapi-processor-spring/workflows/ci/badge.svg
6- :oaps-ci: https://github.com/hauner /openapi-processor-spring/actions?query=workflow%3Aci
7- :oaps-issues: https://github.com/hauner /openapi-processor-spring/issues
8- :oaps-inttests: https://github.com/hauner /openapi-processor-spring/tree/master/src/testInt/resources
9- :oaps-license: https://github.com/hauner /openapi-processor-spring/blob/master/LICENSE
10- :oaps-releases: https://github.com/hauner /openapi-processor-spring/releases
11- :oaps-bintray: https://bintray.com/hauner /openapi-processor
12- :oap-gradle: https://github.com/hauner /openapi-processor-gradle
5+ :badge-ci: https://github.com/openapi-processor /openapi-processor-spring/workflows/ci/badge.svg
6+ :oaps-ci: https://github.com/openapi-processor /openapi-processor-spring/actions?query=workflow%3Aci
7+ :oaps-issues: https://github.com/openapi-processor /openapi-processor-spring/issues
8+ :oaps-inttests: https://github.com/openapi-processor /openapi-processor-spring/tree/master/src/testInt/resources
9+ :oaps-license: https://github.com/openapi-processor /openapi-processor-spring/blob/master/LICENSE
10+ :oaps-releases: https://github.com/openapi-processor /openapi-processor-spring/releases
11+ :oaps-bintray: https://bintray.com/openapi-processor /openapi-processor
12+ :oap-gradle: https://github.com/openapi-processor /openapi-processor-gradle
1313:oap-playground: https://openapi-processor-playground.appspot.com
1414
1515//
You can’t perform that action at this time.
0 commit comments