forked from smallrye/smallrye-open-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OpenApiConfig.java
320 lines (254 loc) · 12.2 KB
/
OpenApiConfig.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
package io.smallrye.openapi.api;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.openapi.OASConfig;
import io.smallrye.openapi.api.constants.JsonbConstants;
/**
* Accessor to OpenAPI configuration options.
*
* Reference:
* https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc#list-of-configurable-items
*
* @author eric.wittmann@gmail.com
*/
public interface OpenApiConfig {
/**
* Set of classes which should never be scanned, regardless of user configuration.
*/
public static final Set<String> NEVER_SCAN_CLASSES = Collections
.unmodifiableSet(new HashSet<>(Arrays.asList()));
/**
* Set of packages which should never be scanned, regardless of user configuration.
*/
public static final Set<String> NEVER_SCAN_PACKAGES = Collections
.unmodifiableSet(new HashSet<>(Arrays.asList("java.lang")));
/**
* Default set of packages with annotations that should not be checked for
* nested/composed annotations. For example, the annotations
* <code>org.jetbrains.annotations.NotNull</code> will not be checked for
* additional annotations. Generally, only application-provided custom
* annotations would be used to compose multiple OpenAPI annotations. This
* list allows the scanner to short-circuit the scanning of an excessive
* number of annotations.
*/
public static final Set<String> DEFAULT_COMPOSITION_EXCLUDE_PACKAGES = Collections
.unmodifiableSet(new HashSet<>(Arrays.asList(
"java",
"jakarta",
"kotlin",
"com.fasterxml.jackson",
"io.quarkus",
"org.eclipse.microprofile.openapi",
"org.jetbrains.annotations")));
enum OperationIdStrategy {
METHOD,
CLASS_METHOD,
PACKAGE_CLASS_METHOD
}
enum DuplicateOperationIdBehavior {
FAIL,
WARN
}
enum AutoInheritance {
NONE,
BOTH,
PARENT_ONLY
}
public static OpenApiConfig fromConfig(Config config) {
return new OpenApiConfigImpl(config);
}
DuplicateOperationIdBehavior DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT = DuplicateOperationIdBehavior.WARN;
Integer MAXIMUM_STATIC_FILE_SIZE_DEFAULT = 3 * 1024 * 1024;
<R, T> T getConfigValue(String propertyName, Class<R> type, Function<R, T> converter, Supplier<T> defaultValue);
<R, T> Map<String, T> getConfigValueMap(String propertyNamePrefix, Class<R> type, Function<R, T> converter);
default <T> T getConfigValue(String propertyName, Class<T> type, Supplier<T> defaultValue) {
return getConfigValue(propertyName, type, Function.identity(), defaultValue);
}
default String modelReader() {
return getConfigValue(OASConfig.MODEL_READER, String.class, () -> null);
}
default String filter() {
return getConfigValue(OASConfig.FILTER, String.class, () -> null);
}
default boolean scanDisable() {
return getConfigValue(OASConfig.SCAN_DISABLE, Boolean.class, () -> Boolean.FALSE);
}
default Set<String> scanPackages() {
return getConfigValue(OASConfig.SCAN_PACKAGES, String[].class, this::toSet, Collections::emptySet);
}
default Set<String> scanClasses() {
return getConfigValue(OASConfig.SCAN_CLASSES, String[].class, this::toSet, Collections::emptySet);
}
default Set<String> scanExcludePackages() {
return getConfigValue(OASConfig.SCAN_EXCLUDE_PACKAGES, String[].class, values -> {
Set<String> valueSet = toSet(values);
valueSet.addAll(NEVER_SCAN_PACKAGES);
return Collections.unmodifiableSet(valueSet);
}, () -> NEVER_SCAN_PACKAGES);
}
default Set<String> scanExcludeClasses() {
return getConfigValue(OASConfig.SCAN_EXCLUDE_CLASSES, String[].class, values -> {
Set<String> valueSet = toSet(values);
valueSet.addAll(NEVER_SCAN_CLASSES);
return Collections.unmodifiableSet(valueSet);
}, () -> NEVER_SCAN_CLASSES);
}
default boolean scanBeanValidation() {
return getConfigValue(OASConfig.SCAN_BEANVALIDATION, Boolean.class, () -> Boolean.TRUE);
}
default List<String> servers() {
return getConfigValue(OASConfig.SERVERS, String[].class, this::toList, Collections::emptyList);
}
default List<String> pathServers(String path) {
return getConfigValue(OASConfig.SERVERS_PATH_PREFIX + path, String[].class, this::toList, Collections::emptyList);
}
default List<String> operationServers(String operationId) {
return getConfigValue(OASConfig.SERVERS_OPERATION_PREFIX + operationId, String[].class, this::toList,
Collections::emptyList);
}
default boolean scanDependenciesDisable() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_SCAN_DEPENDENCIES_DISABLE, Boolean.class,
() -> getConfigValue(SmallRyeOASConfig.SCAN_DEPENDENCIES_DISABLE, Boolean.class,
() -> Boolean.FALSE));
}
default Set<String> scanDependenciesJars() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_SCAN_DEPENDENCIES_JARS, String[].class, this::toSet,
() -> getConfigValue(SmallRyeOASConfig.SCAN_DEPENDENCIES_JARS, String[].class, this::toSet,
Collections::emptySet));
}
default boolean arrayReferencesEnable() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_ARRAY_REFERENCES_ENABLE, Boolean.class, () -> Boolean.TRUE);
}
default String customSchemaRegistryClass() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_CUSTOM_SCHEMA_REGISTRY_CLASS, String.class,
() -> getConfigValue(SmallRyeOASConfig.CUSTOM_SCHEMA_REGISTRY_CLASS, String.class,
() -> null));
}
default boolean applicationPathDisable() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_APP_PATH_DISABLE, Boolean.class,
() -> getConfigValue(SmallRyeOASConfig.APP_PATH_DISABLE, Boolean.class,
() -> Boolean.FALSE));
}
default boolean privatePropertiesEnable() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_PRIVATE_PROPERTIES_ENABLE, Boolean.class, () -> Boolean.TRUE);
}
default String propertyNamingStrategy() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_PROPERTY_NAMING_STRATEGY, String.class, () -> JsonbConstants.IDENTITY);
}
default boolean sortedPropertiesEnable() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_SORTED_PROPERTIES_ENABLE, Boolean.class, () -> Boolean.FALSE);
}
default Map<String, String> getSchemas() {
return getConfigValueMap(OASConfig.SCHEMA_PREFIX, String.class, Function.identity());
}
// Here we extend this in SmallRye with some more configure options (mp.openapi.extensions)
default String getOpenApiVersion() {
return getConfigValue(SmallRyeOASConfig.VERSION, String.class, () -> null);
}
default String getInfoTitle() {
return getConfigValue(SmallRyeOASConfig.INFO_TITLE, String.class, () -> null);
}
default String getInfoVersion() {
return getConfigValue(SmallRyeOASConfig.INFO_VERSION, String.class, () -> null);
}
default String getInfoDescription() {
return getConfigValue(SmallRyeOASConfig.INFO_DESCRIPTION, String.class, () -> null);
}
default String getInfoTermsOfService() {
return getConfigValue(SmallRyeOASConfig.INFO_TERMS, String.class, () -> null);
}
default String getInfoContactEmail() {
return getConfigValue(SmallRyeOASConfig.INFO_CONTACT_EMAIL, String.class, () -> null);
}
default String getInfoContactName() {
return getConfigValue(SmallRyeOASConfig.INFO_CONTACT_NAME, String.class, () -> null);
}
default String getInfoContactUrl() {
return getConfigValue(SmallRyeOASConfig.INFO_CONTACT_URL, String.class, () -> null);
}
default String getInfoLicenseName() {
return getConfigValue(SmallRyeOASConfig.INFO_LICENSE_NAME, String.class, () -> null);
}
default String getInfoLicenseUrl() {
return getConfigValue(SmallRyeOASConfig.INFO_LICENSE_URL, String.class, () -> null);
}
default OperationIdStrategy getOperationIdStrategy() {
return getConfigValue(SmallRyeOASConfig.OPERATION_ID_STRAGEGY, String.class, OperationIdStrategy::valueOf, () -> null);
}
default DuplicateOperationIdBehavior getDuplicateOperationIdBehavior() {
return getConfigValue(SmallRyeOASConfig.DUPLICATE_OPERATION_ID_BEHAVIOR,
String.class,
DuplicateOperationIdBehavior::valueOf,
() -> DUPLICATE_OPERATION_ID_BEHAVIOR_DEFAULT);
}
default Optional<String[]> getDefaultProduces() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_PRODUCES, String[].class, Optional::of, Optional::empty);
}
default Optional<String[]> getDefaultConsumes() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_CONSUMES, String[].class, Optional::of, Optional::empty);
}
default Optional<String[]> getDefaultPrimitivesProduces() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_PRODUCES_PRIMITIVES, String[].class, Optional::of, Optional::empty);
}
default Optional<String[]> getDefaultPrimitivesConsumes() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_CONSUMES_PRIMITIVES, String[].class, Optional::of, Optional::empty);
}
default Optional<String[]> getDefaultStreamingProduces() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_PRODUCES_STREAMING, String[].class, Optional::of, Optional::empty);
}
default Optional<String[]> getDefaultStreamingConsumes() {
return getConfigValue(SmallRyeOASConfig.DEFAULT_CONSUMES_STREAMING, String[].class, Optional::of, Optional::empty);
}
default Optional<Boolean> allowNakedPathParameter() {
return Optional.empty();
}
void setAllowNakedPathParameter(Boolean allowNakedPathParameter);
default void doAllowNakedPathParameter() {
setAllowNakedPathParameter(Boolean.TRUE);
}
default Set<String> getScanProfiles() {
return getConfigValue(SmallRyeOASConfig.SCAN_PROFILES, String[].class, this::toSet, Collections::emptySet);
}
default Set<String> getScanExcludeProfiles() {
return getConfigValue(SmallRyeOASConfig.SCAN_EXCLUDE_PROFILES, String[].class, this::toSet, Collections::emptySet);
}
default Map<String, String> getScanResourceClasses() {
return getConfigValueMap(SmallRyeOASConfig.SCAN_RESOURCE_CLASS_PREFIX, String.class, Function.identity());
}
default boolean removeUnusedSchemas() {
return getConfigValue(SmallRyeOASConfig.SMALLRYE_REMOVE_UNUSED_SCHEMAS, Boolean.class, () -> Boolean.FALSE);
}
default Integer getMaximumStaticFileSize() {
return getConfigValue(SmallRyeOASConfig.MAXIMUM_STATIC_FILE_SIZE, Integer.class,
() -> MAXIMUM_STATIC_FILE_SIZE_DEFAULT);
}
default AutoInheritance getAutoInheritance() {
return getConfigValue(SmallRyeOASConfig.AUTO_INHERITANCE, String.class, AutoInheritance::valueOf,
() -> AutoInheritance.NONE);
}
default Set<String> getScanCompositionExcludePackages() {
return getConfigValue(SmallRyeOASConfig.SCAN_COMPOSITION_EXCLUDE_PACKAGES, String[].class, this::toSet,
() -> DEFAULT_COMPOSITION_EXCLUDE_PACKAGES);
}
default Set<String> toSet(String[] items) {
return Arrays.stream(items)
.map(String::trim)
.collect(Collectors.toCollection(LinkedHashSet::new));
}
default List<String> toList(String[] items) {
return Arrays.stream(items)
.map(String::trim)
.collect(Collectors.toCollection(ArrayList::new));
}
}