-
-
Notifications
You must be signed in to change notification settings - Fork 467
/
SpringDocConfigProperties.java
1432 lines (1247 loc) · 26.9 KB
/
SpringDocConfigProperties.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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
*
* *
* * *
* * * * 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;
import java.util.ArrayList;
import java.util.List;
import org.springdoc.core.SpringDocConfigProperties.ModelConverters.SortConverter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;
import org.springframework.http.MediaType;
import static org.springdoc.core.Constants.DEFAULT_WEB_JARS_PREFIX_URL;
import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
/**
* The type Spring doc config properties.
* @author bnasslahsen
*/
@Lazy(false)
@Configuration(proxyBeanMethods = false)
@ConfigurationProperties(prefix = Constants.SPRINGDOC_PREFIX)
@ConditionalOnProperty(name = SPRINGDOC_ENABLED, matchIfMissing = true)
public class SpringDocConfigProperties {
/**
* The Show actuator.
*/
private boolean showActuator;
/**
* The Webjars.
*/
private Webjars webjars = new Webjars();
/**
* The Api docs.
*/
private ApiDocs apiDocs = new ApiDocs();
/**
* The Packages to scan.
*/
private List<String> packagesToScan;
/**
* The Packages to exclude.
*/
private List<String> packagesToExclude;
/**
* The Paths to match.
*/
private List<String> pathsToMatch;
/**
* 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 Cache.
*/
private Cache cache = new Cache();
/**
* The Group configs.
*/
private List<GroupConfig> groupConfigs = new ArrayList<>();
/**
* The Auto tag classes.
*/
private boolean autoTagClasses = true;
/**
* The Model and view allowed.
*/
private boolean modelAndViewAllowed;
/**
* The Override with generic response.
*/
private Boolean overrideWithGenericResponse;
/**
* The Remove broken reference definitions.
*/
private boolean removeBrokenReferenceDefinitions = true;
/**
* The Writer with default pretty printer.
*/
private boolean writerWithDefaultPrettyPrinter;
/**
* The Writer with order by keys.
*/
private boolean writerWithOrderByKeys;
/**
* The Default consumes media type.
*/
private String defaultConsumesMediaType = MediaType.APPLICATION_JSON_VALUE;
/**
* The Default produces media type.
*/
private String defaultProducesMediaType = MediaType.ALL_VALUE;
/**
* Use fully qualified name
*/
private boolean useFqn;
/**
* The Show login endpoint.
*/
private boolean showLoginEndpoint;
/**
* Allow for pre-loading OpenAPI
*/
private boolean preLoadingEnabled;
/**
* If set to true, exposes the swagger-ui on the actuator management port.
*/
private boolean useManagementPort;
/**
* The Disable i18n.
*/
private boolean disableI18n;
/**
* The Show spring cloud functions.
*/
private boolean showSpringCloudFunctions;
/**
* The param default flatten
*/
private boolean defaultFlatParamObject;
/**
* The model Converters
*/
private ModelConverters modelConverters = new ModelConverters();
/**
* The Sort converter.
*/
private SortConverter sortConverter = new SortConverter();
/**
* Gets sort converter.
*
* @return the sort converter
*/
public SortConverter getSortConverter() {
return sortConverter;
}
/**
* Sets sort converter.
*
* @param sortConverter the sort converter
*/
public void setSortConverter(SortConverter sortConverter) {
this.sortConverter = sortConverter;
}
/**
* Is show spring cloud functions boolean.
*
* @return the boolean
*/
public boolean isShowSpringCloudFunctions() {
return showSpringCloudFunctions;
}
/**
* Sets show spring cloud functions.
*
* @param showSpringCloudFunctions the show spring cloud functions
*/
public void setShowSpringCloudFunctions(boolean showSpringCloudFunctions) {
this.showSpringCloudFunctions = showSpringCloudFunctions;
}
/**
* Is default flat param object
* @return the boolean
*/
public boolean isDefaultFlatParamObject() {
return defaultFlatParamObject;
}
public void setDefaultFlatParamObject(boolean defaultFlatParamObject) {
this.defaultFlatParamObject = defaultFlatParamObject;
}
/**
* Gets model converters.
*
* @return the model converters
*/
public ModelConverters getModelConverters() {
return modelConverters;
}
/**
* Sets model converters.
*
* @param modelConverters the model converters
*/
public void setModelConverters(ModelConverters modelConverters) {
this.modelConverters = modelConverters;
}
/**
* Is use management port boolean.
*
* @return the boolean
*/
public boolean isUseManagementPort() {
return useManagementPort;
}
/**
* Sets use management port.
*
* @param useManagementPort the use management port
*/
public void setUseManagementPort(boolean useManagementPort) {
this.useManagementPort = useManagementPort;
}
/**
* Gets produces to match.
*
* @return the produces to match
*/
public List<String> getProducesToMatch() {
return producesToMatch;
}
/**
* Sets produces to match.
*
* @param producesToMatch the produces to match
*/
public void setProducesToMatch(List<String> producesToMatch) {
this.producesToMatch = producesToMatch;
}
/**
* Gets headers to match.
*
* @return the headers to match
*/
public List<String> getHeadersToMatch() {
return headersToMatch;
}
/**
* Sets headers to match.
*
* @param headersToMatch the headers to match
*/
public void setHeadersToMatch(List<String> headersToMatch) {
this.headersToMatch = headersToMatch;
}
/**
* Gets consumes to match.
*
* @return the consumes to match
*/
public List<String> getConsumesToMatch() {
return consumesToMatch;
}
/**
* Sets consumes to match.
*
* @param consumesToMatch the consumes to match
*/
public void setConsumesToMatch(List<String> consumesToMatch) {
this.consumesToMatch = consumesToMatch;
}
/**
* Is use fqn boolean.
*
* @return the boolean
*/
public boolean isUseFqn() {
return useFqn;
}
/**
* Sets use fqn.
*
* @param useFqn the use fqn
*/
public void setUseFqn(boolean useFqn) {
this.useFqn = useFqn;
}
/**
* Is auto tag classes boolean.
*
* @return the boolean
*/
public boolean isAutoTagClasses() {
return autoTagClasses;
}
/**
* Sets auto tag classes.
*
* @param autoTagClasses the auto tag classes
*/
public void setAutoTagClasses(boolean autoTagClasses) {
this.autoTagClasses = autoTagClasses;
}
/**
* Is model and view allowed boolean.
*
* @return the boolean
*/
public boolean isModelAndViewAllowed() {
return modelAndViewAllowed;
}
/**
* Sets model and view allowed.
*
* @param modelAndViewAllowed the model and view allowed
*/
public void setModelAndViewAllowed(boolean modelAndViewAllowed) {
this.modelAndViewAllowed = modelAndViewAllowed;
}
/**
* Gets packages to exclude.
*
* @return the packages to exclude
*/
public List<String> getPackagesToExclude() {
return packagesToExclude;
}
/**
* Sets packages to exclude.
*
* @param packagesToExclude the packages to exclude
*/
public void setPackagesToExclude(List<String> packagesToExclude) {
this.packagesToExclude = packagesToExclude;
}
/**
* Gets paths to exclude.
*
* @return the paths to exclude
*/
public List<String> getPathsToExclude() {
return pathsToExclude;
}
/**
* Sets paths to exclude.
*
* @param pathsToExclude the paths to exclude
*/
public void setPathsToExclude(List<String> pathsToExclude) {
this.pathsToExclude = pathsToExclude;
}
/**
* Is show login endpoint boolean.
*
* @return the boolean
*/
public boolean isShowLoginEndpoint() {
return showLoginEndpoint;
}
/**
* Sets show login endpoint.
*
* @param showLoginEndpoint the show login endpoint
*/
public void setShowLoginEndpoint(boolean showLoginEndpoint) {
this.showLoginEndpoint = showLoginEndpoint;
}
/**
* Gets packages to scan.
*
* @return the packages to scan
*/
public List<String> getPackagesToScan() {
return packagesToScan;
}
/**
* Sets packages to scan.
*
* @param packagesToScan the packages to scan
*/
public void setPackagesToScan(List<String> packagesToScan) {
this.packagesToScan = packagesToScan;
}
/**
* Is show actuator boolean.
*
* @return the boolean
*/
public boolean isShowActuator() {
return showActuator;
}
/**
* Sets show actuator.
*
* @param showActuator the show actuator
*/
public void setShowActuator(boolean showActuator) {
this.showActuator = showActuator;
}
/**
* Gets webjars.
*
* @return the webjars
*/
public Webjars getWebjars() {
return webjars;
}
/**
* Sets webjars.
*
* @param webjars the webjars
*/
public void setWebjars(Webjars webjars) {
this.webjars = webjars;
}
/**
* Gets api docs.
*
* @return the api docs
*/
public ApiDocs getApiDocs() {
return apiDocs;
}
/**
* Sets api docs.
*
* @param apiDocs the api docs
*/
public void setApiDocs(ApiDocs apiDocs) {
this.apiDocs = apiDocs;
}
/**
* Gets paths to match.
*
* @return the paths to match
*/
public List<String> getPathsToMatch() {
return pathsToMatch;
}
/**
* Sets paths to match.
*
* @param pathsToMatch the paths to match
*/
public void setPathsToMatch(List<String> pathsToMatch) {
this.pathsToMatch = pathsToMatch;
}
/**
* Gets cache.
*
* @return the cache
*/
public Cache getCache() {
return cache;
}
/**
* Sets cache.
*
* @param cache the cache
*/
public void setCache(Cache cache) {
this.cache = cache;
}
/**
* Is cache disabled boolean.
*
* @return the boolean
*/
public boolean isCacheDisabled() {
return cache.isDisabled();
}
/**
* Gets group configs.
*
* @return the group configs
*/
public List<GroupConfig> getGroupConfigs() {
return groupConfigs;
}
/**
* Sets group configs.
*
* @param groupConfigs the group configs
*/
public void setGroupConfigs(List<GroupConfig> groupConfigs) {
this.groupConfigs = groupConfigs;
}
/**
* Add group config.
*
* @param groupConfigs the group configs
*/
public void addGroupConfig(GroupConfig groupConfigs) {
this.groupConfigs.add(groupConfigs);
}
/**
* Gets default consumes media type.
*
* @return the default consumes media type
*/
public String getDefaultConsumesMediaType() {
return defaultConsumesMediaType;
}
/**
* Sets default consumes media type.
*
* @param defaultConsumesMediaType the default consumes media type
*/
public void setDefaultConsumesMediaType(String defaultConsumesMediaType) {
this.defaultConsumesMediaType = defaultConsumesMediaType;
}
/**
* Gets default produces media type.
*
* @return the default produces media type
*/
public String getDefaultProducesMediaType() {
return defaultProducesMediaType;
}
/**
* Sets default produces media type.
*
* @param defaultProducesMediaType the default produces media type
*/
public void setDefaultProducesMediaType(String defaultProducesMediaType) {
this.defaultProducesMediaType = defaultProducesMediaType;
}
/**
* Is override with generic response boolean.
*
* @return the boolean
*/
public boolean isOverrideWithGenericResponse() {
return overrideWithGenericResponse != null && overrideWithGenericResponse;
}
/**
* Gets default override with generic response.
*
* @return the default override with generic response
*/
public boolean isDefaultOverrideWithGenericResponse() {
if (overrideWithGenericResponse == null)
return true;
else
return overrideWithGenericResponse;
}
/**
* Sets override with generic response.
*
* @param overrideWithGenericResponse the override with generic response
*/
public void setOverrideWithGenericResponse(Boolean overrideWithGenericResponse) {
this.overrideWithGenericResponse = overrideWithGenericResponse;
}
/**
* Is remove broken reference definitions boolean.
*
* @return the boolean
*/
public boolean isRemoveBrokenReferenceDefinitions() {
return removeBrokenReferenceDefinitions;
}
/**
* Sets remove broken reference definitions.
*
* @param removeBrokenReferenceDefinitions the remove broken reference definitions
*/
public void setRemoveBrokenReferenceDefinitions(boolean removeBrokenReferenceDefinitions) {
this.removeBrokenReferenceDefinitions = removeBrokenReferenceDefinitions;
}
/**
* Is writer wither order by keys boolean.
*
* @return the boolean
*/
public boolean isWriterWithOrderByKeys() {
return writerWithOrderByKeys;
}
/**
* Sets writer wither order by keys.
*
* @param writerWithOrderByKeys the writer wither order by keys
*/
public void setWriterWithOrderByKeys(boolean writerWithOrderByKeys) {
this.writerWithOrderByKeys = writerWithOrderByKeys;
}
/**
* Is writer with default pretty printer boolean.
*
* @return the boolean
*/
public boolean isWriterWithDefaultPrettyPrinter() {
return writerWithDefaultPrettyPrinter;
}
/**
* Sets writer with default pretty printer.
*
* @param writerWithDefaultPrettyPrinter the writer with default pretty printer
*/
public void setWriterWithDefaultPrettyPrinter(boolean writerWithDefaultPrettyPrinter) {
this.writerWithDefaultPrettyPrinter = writerWithDefaultPrettyPrinter;
}
/**
* Sets pre loading enabled.
*
* @param preLoadingEnabled the pre loading enabled
*/
public void setPreLoadingEnabled(boolean preLoadingEnabled) {
this.preLoadingEnabled = preLoadingEnabled;
}
/**
* Is disable i 18 n boolean.
*
* @return the boolean
*/
public boolean isDisableI18n() {
return disableI18n;
}
/**
* Sets disable i 18 n.
*
* @param disableI18n the disable i 18 n
*/
public void setDisableI18n(boolean disableI18n) {
this.disableI18n = disableI18n;
}
/**
* Is pre loading enabled boolean.
*
* @return the boolean
*/
public boolean isPreLoadingEnabled() {
return preLoadingEnabled;
}
/**
* The type Model converters.
* @author bnasslashen
*/
public static class ModelConverters {
/**
* The Deprecating converter.
*/
private DeprecatingConverter deprecatingConverter = new DeprecatingConverter();
/**
* The Pageable converter.
*/
private PageableConverter pageableConverter = new PageableConverter();
/**
* The Polymorphic model converter.
*/
private PolymorphicConverter polymorphicConverter = new PolymorphicConverter();
/**
* Gets deprecating converter.
*
* @return the deprecating converter
*/
public DeprecatingConverter getDeprecatingConverter() {
return deprecatingConverter;
}
/**
* Sets deprecating converter.
*
* @param deprecatingConverter the deprecating converter
*/
public void setDeprecatingConverter(DeprecatingConverter deprecatingConverter) {
this.deprecatingConverter = deprecatingConverter;
}
/**
* Gets pageable converter.
*
* @return the pageable converter
*/
public PageableConverter getPageableConverter() {
return pageableConverter;
}
/**
* Sets pageable converter.
*
* @param pageableConverter the pageable converter
*/
public void setPageableConverter(PageableConverter pageableConverter) {
this.pageableConverter = pageableConverter;
}
/**
* Gets polymorphic model converter.
*
* @return the polymorphic model converter
*/
public PolymorphicConverter getPolymorphicConverter() {
return polymorphicConverter;
}
/**
* Sets polymorphic model converter.
*
* @param polymorphicConverter the polymorphic model converter
*/
public void setPolymorphicConverter(PolymorphicConverter polymorphicConverter) {
this.polymorphicConverter = polymorphicConverter;
}
/**
* The type Sort converter.
* @author daniel-shuy
*/
public static class SortConverter {
/**
* The Enabled.
*/
private boolean enabled;
/**
* Is enabled boolean.
*
* @return the boolean
*/
public boolean isEnabled() {
return enabled;
}
/**
* Sets enabled.
*
* @param enabled the enabled
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
/**
* The type Deprecating converter.
* @author bnasslashen
*/
public static class DeprecatingConverter {
/**
* The Enabled.
*/
private boolean enabled;
/**
* Is enabled boolean.
*
* @return the boolean
*/
public boolean isEnabled() {
return enabled;
}
/**
* Sets enabled.
*
* @param enabled the enabled
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
/**
* The type Polymorphic model converter.
*/
public static class PolymorphicConverter {
/**
* The Enabled.
*/
private boolean enabled;
/**
* Is enabled boolean.
*
* @return the boolean
*/
public boolean isEnabled() {
return enabled;
}
/**
* Sets enabled.
*
* @param enabled the enabled
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
/**
* The type Pageable converter.
* @author bnasslashen
*/
public static class PageableConverter {
/**
* The Enabled.
*/
private boolean enabled;
/**
* Is enabled boolean.
*
* @return the boolean
*/
public boolean isEnabled() {
return enabled;
}
/**
* Sets enabled.
*
* @param enabled the enabled
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
}
}
/**
* The type Webjars.
* @author bnasslahsen
*/
public static class Webjars {
/**
* The Prefix.
*/
private String prefix = DEFAULT_WEB_JARS_PREFIX_URL;
/**
* Gets prefix.
*
* @return the prefix
*/
public String getPrefix() {
return prefix;
}
/**
* Sets prefix.
*
* @param prefix the prefix
*/
public void setPrefix(String prefix) {
this.prefix = prefix;
}
}
/**
* The type Api docs.
* @author bnasslahsen
*/
public static class ApiDocs {
/**
* Path to the generated OpenAPI documentation. For a yaml file, append ".yaml" to the path.
*/
private String path = Constants.DEFAULT_API_DOCS_URL;
/**
* Whether to generate and serve an OpenAPI document.
*/
private boolean enabled = true;
/**
* The Resolve schema properties.
*/
private boolean resolveSchemaProperties;
/**
* The Groups.
*/
private Groups groups = new Groups();
/**
* The OpenAPI version.
*/
private OpenApiVersion version;
/**
* Gets path.
*
* @return the path