You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/asciidoc/modules/openapi.adoc
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,21 +108,25 @@ To avoid this behaviour you can specify maven build phase which suits your needs
108
108
| `${project.dir}`
109
109
|Set base directory used it for loading openAPI template file name.
110
110
111
+
|`excludes`
112
+
|
113
+
|Regular expression used to excludes route. Example: `/web`.
114
+
111
115
|`includes`
112
116
|
113
117
|Regular expression used to includes/keep route. Example: `/api/.*`.
114
118
115
-
|`excludes`
116
-
|
117
-
|Regular expression used to excludes route. Example: `/web`.
119
+
|`javadoc`
120
+
|`on/true`
121
+
|Turn on/off javadoc generation from Java source files. Set to `off` or `false` to turn it off.
118
122
119
123
|`specVersion`
120
124
|`3.0`
121
-
|Set the desired spec output
125
+
|Set the desired spec output. Possible values: `3.0` or `3.1`
122
126
123
127
|`templateName`
124
128
|`openapi.yaml`
125
-
|Set openAPI template file name.
129
+
|Set openAPI template file path.
126
130
127
131
|===
128
132
@@ -191,7 +195,7 @@ You will find the files in the output build directory. If your application is `b
191
195
This is the main difference with previous version. We moved from runtime to build time generation. This way we:
192
196
193
197
- Are able to get our OpenAPI files at build time (of course)
194
-
- At runtime we don't waste resources (CPU, memory) while analyze and build the OpenAPI model
198
+
- At runtime, we don't waste resources (CPU, memory) while analyze and build the OpenAPI model
195
199
- We keep bootstrap as fast as possible
196
200
====
197
201
@@ -254,7 +258,7 @@ Full/complete example available https://github.com/jooby-project/library-demo[he
254
258
255
259
==== JavaDoc comments
256
260
257
-
JavaDoc comments are supported on Java in script and MVC routes.
261
+
JavaDoc comments are supported for script and MVC routes on Java code base. They are enable by default, to turn them off set `javadoc: off` or `javadoc: false` in your maven/gradle plugin.
0 commit comments