File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -12,7 +12,20 @@ permalink: /
1212# openapi-generatr-spring
1313{: .no_toc }
1414
15- a simple [ OpenAPI] [ openapi ] interface only code generator for [ Spring Boot] [ springboot ] .
15+ a simple [ OpenAPI] [ openapi ] interface only (& model) code generator for [ Spring Boot] [ springboot ] .
16+
17+ It is useful in an API first approach where you API is explicitly defined by an OpenAPI yaml file
18+ before it gets implemented.
19+
20+ The generatr generates java interfaces based on the endpoint description of the API and simple POJO
21+ classes for parameter or response objects defined in th API. It is ** your** task to create the controller
22+ classes that implement the interfaces.
23+
24+ The interfaces will help to keep the implementation in sync with the API. If anything relevant changes
25+ in the API the interface changes and the compiler will warn that the interface is not implemented
26+ correctly.
27+
28+ See the [ generatr intro] [ docs-generatr ] {: target ="_ blank"} for a short example.
1629{: .mb-6 }
1730
1831Note that the generatr is still in an early state of development and not all features are completely implemented.
@@ -110,6 +123,7 @@ openapi-generatr-spring is distributed by [Apache License 2.0][license].
110123[ workflow-ci ] : https://github.com/hauner/openapi-generatr-spring/actions?query=workflow%3Aci
111124
112125[ docs-gradle ] : /openapi-generatr-spring/gradle.html
126+ [ docs-generatr ] : /openapi-generatr-spring/generatr/
113127
114128[ bintray ] : https://bintray.com/hauner/openapi-generatr
115129[ generatr-gradle ] : https://github.com/hauner/openapi-generatr-gradle
You can’t perform that action at this time.
0 commit comments