Skip to content

Commit a98e8b8

Browse files
committed
improved
1 parent f67c245 commit a98e8b8

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
# openapi-generatr
2-
3-
# com.github.hauner.openapi.api
4-
5-
provides an interface that can be used to consume an openapi-generatr-{name}, e.g. by using the ServiceLoader. See the gradle plugin.
6-
71
# com.github.hauner.openapi.gradle
82

9-
provides a gradle plugin that uses com.github.hauner.openapi.api.OpenApiGeneratr to load the available openapi-generatrs from the classpath.
3+
a gradle plugin based on the [openapi-generatr-api][generatr-api] to handle all available openapi-generatrs from the classpath.
104

11-
For any found generatr it will add a `generate<id.capitalize()>Api` task and a `generatr<id.capitalize()>` configuration object to the gradle
12-
project. The options objects class is provided by the `OpenApiGeneratr.getOptionsType()` method.
5+
For any found generatr it will add a `generate<id.capitalize()>` task and a `generatr<id.capitalize()>` configuration object to the
6+
gradle project. The options objects class is provided by the `OpenApiGeneratr.getOptionsType()` method.
137

148
For example given a generatr with the name `openapi-generatr-spring` the gradle project will get a
15-
- `generateSpringApi` gradle task
9+
- `generateSpring` gradle task
1610
- and an `generatrSpring` options object
1711

1812
# Sample project
1913

20-
See `openapi-generatr-spring-mvc-sample` for a complete spring boot sample project.
14+
See [`openapi-generatr-spring-mvc-sample`][generatr-spring-mvc] for a complete spring boot sample project.
15+
2116

17+
[generatr-api]: https://github.com/hauner/openapi-generatr-api
18+
[generatr-spring-mvc]: https://github.com/hauner/openapi-generatr-spring-mvc-sample

0 commit comments

Comments
 (0)