Skip to content

Commit 19f4ad0

Browse files
committed
link to docs
1 parent 1574cf5 commit 19f4ad0

File tree

1 file changed

+9
-50
lines changed

1 file changed

+9
-50
lines changed

README.md

Lines changed: 9 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,22 @@
11
[![][badge-license]][oap-license]
22
[![][badge-ci]][workflow-ci]
33

4+
45
![openapi-processor-spring logo](images/openapi-processor-spring@1280x200.png)
56

67
# openapi-processor-spring
78

8-
a simple [OpenAPI][openapi] interface only code generator for [Spring Boot][springboot].
9+
an [OpenAPI][openapi] interface only & model java code generator for [Spring Boot][springboot].
910

1011

11-
# Getting Started
12-
13-
See the [documentation][oap-doc].
14-
15-
16-
# Sample
17-
18-
See [`openapi-processor-spring-mvc-sample`][oap-sample] for a complete working sample of a minimal
19-
openapi.yaml.
20-
21-
# Features & Bugs
22-
23-
In case some feature is missing or the generated code is not 100% what you would expect create an
24-
issue with test case. Providing a test case will help significantly :-)
12+
# Documentation
2513

26-
A test case is a single folder with an openapi.yaml file and the expected Java files the processor
27-
should create. The structure looks like this:
28-
29-
my-new-test-case/
30-
openapi.yaml
31-
mapping.yaml
32-
generated/
33-
api/
34-
AnEndpointInterface.java
35-
.. more api interfaces ..
36-
model/
37-
AModelClass.java
38-
AnotherModelClass.java
39-
.. more model files ..
40-
41-
The `mapping.yaml` contains the type mapping information.
42-
43-
See the [existing integration tests][oap-int-resources] for a couple of examples.
14+
See [here][oap-docs].
15+
4416

4517
[badge-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
46-
[badge-ci]: https://github.com/hauner/openapi-generatr-spring/workflows/ci/badge.svg
47-
48-
[workflow-ci]: https://github.com/hauner/openapi-processor-spring/actions?query=workflow%3Aci
49-
18+
[badge-ci]: https://github.com/hauner/openapi-processor-json/workflows/ci/badge.svg
19+
[oap-license]: https://github.com/hauner/openapi-processor-spring/blob/master/LICENSE
20+
[workflow-ci]: https://github.com/hauner/openapi-processor-json/actions?query=workflow%3Aci
21+
[oap-docs]: https://hauner.github.com/openapi-processor/spring/current/index.html
5022
[openapi]: https://www.openapis.org/
51-
[openapi-spec]: https://github.com/OAI/OpenAPI-Specification
52-
[openapi-spec-types]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#dataTypes
53-
[openapi-spec-exts]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specificationExtensions
54-
55-
[springboot]: https://spring.io/projects/spring-boot
56-
[spring-requestparam]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RequestParam.html
57-
[spring-responseentity]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/ResponseEntity.html
58-
59-
[oap-license]: https://github.com/hauner/openapi-generatr-spring/blob/master/LICENSE
60-
[oap-doc]: https://hauner.github.io/openapi-processor-spring/
61-
[oap-int-resources]: https://github.com/hauner/openapi-processor-spring/tree/master/src/testInt/resources
62-
[oap-gradle]: https://github.com/hauner/openapi-processor-gradle
63-
[oap-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample

0 commit comments

Comments
 (0)