-
-
Notifications
You must be signed in to change notification settings - Fork 467
/
GroupedOpenApi.java
512 lines (450 loc) · 11.6 KB
/
GroupedOpenApi.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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/*
*
* *
* * *
* * * *
* * * * * Copyright 2019-2022 the original author or authors.
* * * * *
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
* * * * * you may not use this file except in compliance with the License.
* * * * * You may obtain a copy of the License at
* * * * *
* * * * * https://www.apache.org/licenses/LICENSE-2.0
* * * * *
* * * * * Unless required by applicable law or agreed to in writing, software
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * * * * See the License for the specific language governing permissions and
* * * * * limitations under the License.
* * * *
* * *
* *
*
*/
package org.springdoc.core.models;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import org.apache.commons.lang3.StringUtils;
import org.springdoc.core.customizers.OpenApiCustomizer;
import org.springdoc.core.customizers.OperationCustomizer;
import org.springdoc.core.filters.OpenApiMethodFilter;
import org.springframework.util.CollectionUtils;
import static org.springdoc.core.utils.Constants.GROUP_NAME_NOT_NULL;
/**
* The type Grouped open api.
* @author bnasslahsen
*/
public class GroupedOpenApi {
/**
* The Group.
*/
private final String group;
/**
* The Open api customisers.
*/
private List<OpenApiCustomizer> openApiCustomizers;
/**
* The Operation customizers.
*/
private List<OperationCustomizer> operationCustomizers;
/**
* The Paths to match.
*/
private final List<String> pathsToMatch;
/**
* The Packages to scan.
*/
private final List<String> packagesToScan;
/**
* The Packages to exclude.
*/
private final List<String> packagesToExclude;
/**
* The Paths to exclude.
*/
private final List<String> pathsToExclude;
/**
* The Produces to match.
*/
private final List<String> producesToMatch;
/**
* The Headers to match.
*/
private final List<String> headersToMatch;
/**
* The Consumes to match.
*/
private final List<String> consumesToMatch;
/**
* The method filters to use.
*/
private List<OpenApiMethodFilter> openApiMethodFilters;
/**
* The Display name.
*/
private final String displayName;
/**
* Instantiates a new Grouped open api.
*
* @param builder the builder
*/
private GroupedOpenApi(Builder builder) {
this.group = Objects.requireNonNull(builder.group, GROUP_NAME_NOT_NULL);
this.pathsToMatch = builder.pathsToMatch;
this.packagesToScan = builder.packagesToScan;
this.producesToMatch = builder.producesToMatch;
this.consumesToMatch = builder.consumesToMatch;
this.headersToMatch = builder.headersToMatch;
this.packagesToExclude = builder.packagesToExclude;
this.pathsToExclude = builder.pathsToExclude;
this.displayName = StringUtils.defaultIfEmpty(builder.displayName, this.group);
this.openApiCustomizers = Objects.requireNonNull(builder.openApiCustomizers);
this.operationCustomizers = Objects.requireNonNull(builder.operationCustomizers);
this.openApiMethodFilters = Objects.requireNonNull(builder.methodFilters);
if (CollectionUtils.isEmpty(this.pathsToMatch)
&& CollectionUtils.isEmpty(this.packagesToScan)
&& CollectionUtils.isEmpty(this.producesToMatch)
&& CollectionUtils.isEmpty(this.consumesToMatch)
&& CollectionUtils.isEmpty(this.headersToMatch)
&& CollectionUtils.isEmpty(this.pathsToExclude)
&& CollectionUtils.isEmpty(this.packagesToExclude)
&& CollectionUtils.isEmpty(openApiCustomizers)
&& CollectionUtils.isEmpty(operationCustomizers)
&& CollectionUtils.isEmpty(openApiMethodFilters))
throw new IllegalStateException("Packages to scan or paths to filter or openApiCustomizers/operationCustomizers can not be all null for the group:" + this.group);
}
/**
* Builder builder.
*
* @return the builder
*/
public static Builder builder() {
return new Builder();
}
/**
* Gets produces to match.
*
* @return the produces to match
*/
public List<String> getProducesToMatch() {
return producesToMatch;
}
/**
* Gets headers to match.
*
* @return the headers to match
*/
public List<String> getHeadersToMatch() {
return headersToMatch;
}
/**
* Gets consumes to match.
*
* @return the consumes to match
*/
public List<String> getConsumesToMatch() {
return consumesToMatch;
}
/**
* Gets group.
*
* @return the group
*/
public String getGroup() {
return group;
}
/**
* Gets paths to match.
*
* @return the paths to match
*/
public List<String> getPathsToMatch() {
return pathsToMatch;
}
/**
* Gets packages to scan.
*
* @return the packages to scan
*/
public List<String> getPackagesToScan() {
return packagesToScan;
}
/**
* Gets packages to exclude.
*
* @return the packages to exclude
*/
public List<String> getPackagesToExclude() {
return packagesToExclude;
}
/**
* Gets paths to exclude.
*
* @return the paths to exclude
*/
public List<String> getPathsToExclude() {
return pathsToExclude;
}
/**
* Gets open api customisers.
*
* @return the open api customisers
*/
public List<OpenApiCustomizer> getOpenApiCustomizers() {
return openApiCustomizers;
}
/**
* Gets operation customizers.
*
* @return the operation customizers
*/
public List<OperationCustomizer> getOperationCustomizers() {
return operationCustomizers;
}
/**
* Gets open api method filters.
*
* @return the open api method filters
*/
public List<OpenApiMethodFilter> getOpenApiMethodFilters() {
return openApiMethodFilters;
}
/**
* Gets display name.
*
* @return the display name
*/
public String getDisplayName() {
return displayName;
}
/**
* The type Builder.
* @author bnasslahsen
*/
public static class Builder {
/**
* The Open api customisers.
*/
private final List<OpenApiCustomizer> openApiCustomizers = new ArrayList<>();
/**
* The Operation customizers.
*/
private final List<OperationCustomizer> operationCustomizers = new ArrayList<>();
/**
* The methods filters to apply.
*/
private final List<OpenApiMethodFilter> methodFilters = new ArrayList<>();
/**
* The Group.
*/
private String group;
/**
* The Paths to match.
*/
private List<String> pathsToMatch;
/**
* The Packages to scan.
*/
private List<String> packagesToScan;
/**
* The Packages to exclude.
*/
private List<String> packagesToExclude;
/**
* The Paths to exclude.
*/
private List<String> pathsToExclude;
/**
* The Produces to match.
*/
private List<String> producesToMatch;
/**
* The Headers to match.
*/
private List<String> headersToMatch;
/**
* The Consumes to match.
*/
private List<String> consumesToMatch;
/**
* The Display name.
*/
private String displayName;
/**
* Instantiates a new Builder.
*/
private Builder() {
// use static factory method in parent class
}
/**
* Group builder.
*
* @param group the group
* @return the builder
*/
public Builder group(String group) {
this.group = group;
return this;
}
/**
* Paths to match builder.
*
* @param pathsToMatch the paths to match
* @return the builder
*/
public Builder pathsToMatch(String... pathsToMatch) {
this.pathsToMatch = Arrays.asList(pathsToMatch);
return this;
}
/**
* Packages to scan builder.
*
* @param packagesToScan the packages to scan
* @return the builder
*/
public Builder packagesToScan(String... packagesToScan) {
this.packagesToScan = Arrays.asList(packagesToScan);
return this;
}
/**
* Produces to match builder.
*
* @param producesToMatch the produces to match
* @return the builder
*/
public Builder producesToMatch(String... producesToMatch) {
this.producesToMatch = Arrays.asList(producesToMatch);
return this;
}
/**
* Consumes to match builder.
*
* @param consumesToMatch the consumes to match
* @return the builder
*/
public Builder consumesToMatch(String... consumesToMatch) {
this.consumesToMatch = Arrays.asList(consumesToMatch);
return this;
}
/**
* Headers to match builder.
*
* @param headersToMatch the headers to match
* @return the builder
*/
public Builder headersToMatch(String... headersToMatch) {
this.headersToMatch = Arrays.asList(headersToMatch);
return this;
}
/**
* Paths to exclude builder.
*
* @param pathsToExclude the paths to exclude
* @return the builder
*/
public Builder pathsToExclude(String... pathsToExclude) {
this.pathsToExclude = Arrays.asList(pathsToExclude);
return this;
}
/**
* Packages to exclude builder.
*
* @param packagesToExclude the packages to exclude
* @return the builder
*/
public Builder packagesToExclude(String... packagesToExclude) {
this.packagesToExclude = Arrays.asList(packagesToExclude);
return this;
}
/**
* Add open api customiser builder.
*
* @param openApiCustomizer the open api customiser
* @return the builder
*/
public Builder addOpenApiCustomizer(OpenApiCustomizer openApiCustomizer) {
this.openApiCustomizers.add(openApiCustomizer);
return this;
}
/**
* Add operation customizer builder.
*
* @param operationCustomizer the operation customizer
* @return the builder
*/
public Builder addOperationCustomizer(OperationCustomizer operationCustomizer) {
this.operationCustomizers.add(operationCustomizer);
return this;
}
/**
* Add method filter.
*
* @param methodFilter an additional filter to apply to the matched methods
* @return the builder
*/
public Builder addOpenApiMethodFilter(OpenApiMethodFilter methodFilter) {
this.methodFilters.add(methodFilter);
return this;
}
/**
* Display name builder.
*
* @param displayName the display name
* @return the builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Build grouped open api.
*
* @return the grouped open api
*/
public GroupedOpenApi build() {
return new GroupedOpenApi(this);
}
}
/**
* Add all open api customizer grouped open api.
*
* @param openApiCustomizerCollection the open api customizer collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOpenApiCustomizer(Collection<? extends OpenApiCustomizer> openApiCustomizerCollection) {
List<OpenApiCustomizer> result = new ArrayList<>();
result.addAll(openApiCustomizerCollection);
result.addAll(openApiCustomizers);
openApiCustomizers = result;
return this;
}
/**
* Add all operation customizer grouped open api.
*
* @param operationCustomizerCollection the operation customizer collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection) {
List<OperationCustomizer> result = new ArrayList<>();
result.addAll(operationCustomizerCollection);
result.addAll(operationCustomizers);
operationCustomizers = result;
return this;
}
/**
* Add all open api method filter grouped open api.
*
* @param openApiMethodFilterCollection the open api method filter collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection) {
List<OpenApiMethodFilter> result = new ArrayList<>();
result.addAll(openApiMethodFilterCollection);
result.addAll(openApiMethodFilters);
openApiMethodFilters = result;
return this;
}
}