Skip to content

Commit f25c2df

Browse files
committed
saving work
2 parents de9cd7e + b664aa0 commit f25c2df

36 files changed

+335
-325
lines changed

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@
6666
import org.apache.commons.lang3.StringUtils;
6767
import org.slf4j.Logger;
6868
import org.slf4j.LoggerFactory;
69-
import org.springdoc.core.AbstractRequestBuilder;
69+
import org.springdoc.core.AbstractRequestService;
7070
import org.springdoc.core.ActuatorProvider;
71-
import org.springdoc.core.GenericParameterBuilder;
72-
import org.springdoc.core.GenericResponseBuilder;
71+
import org.springdoc.core.GenericParameterService;
72+
import org.springdoc.core.GenericResponseService;
7373
import org.springdoc.core.MethodAttributes;
74-
import org.springdoc.core.OpenAPIBuilder;
75-
import org.springdoc.core.OperationBuilder;
74+
import org.springdoc.core.OpenAPIService;
75+
import org.springdoc.core.OperationService;
7676
import org.springdoc.core.SpringDocConfigProperties;
7777
import org.springdoc.core.SpringDocConfigProperties.GroupConfig;
7878
import org.springdoc.core.annotations.RouterOperations;
@@ -121,12 +121,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
121121
/**
122122
* The Open api builder.
123123
*/
124-
protected OpenAPIBuilder openAPIBuilder;
124+
protected OpenAPIService openAPIService;
125125

126126
/**
127127
* The open api builder object factory.
128128
*/
129-
private final ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory;
129+
private final ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory;
130130

131131
/**
132132
* The Spring doc config properties.
@@ -141,17 +141,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
141141
/**
142142
* The Request builder.
143143
*/
144-
private final AbstractRequestBuilder requestBuilder;
144+
private final AbstractRequestService requestBuilder;
145145

146146
/**
147147
* The Response builder.
148148
*/
149-
private final GenericResponseBuilder responseBuilder;
149+
private final GenericResponseService responseBuilder;
150150

151151
/**
152152
* The Operation parser.
153153
*/
154-
private final OperationBuilder operationParser;
154+
private final OperationService operationParser;
155155

156156
/**
157157
* The Open api customisers.
@@ -186,17 +186,17 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
186186
* @param springDocConfigProperties the spring doc config properties
187187
* @param actuatorProvider the actuator provider
188188
*/
189-
protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory,
190-
AbstractRequestBuilder requestBuilder,
191-
GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
189+
protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory,
190+
AbstractRequestService requestBuilder,
191+
GenericResponseService responseBuilder, OperationService operationParser,
192192
Optional<List<OperationCustomizer>> operationCustomizers,
193193
Optional<List<OpenApiCustomiser>> openApiCustomisers,
194194
SpringDocConfigProperties springDocConfigProperties,
195195
Optional<ActuatorProvider> actuatorProvider) {
196196
super();
197197
this.groupName = Objects.requireNonNull(groupName, "groupName");
198198
this.openAPIBuilderObjectFactory = openAPIBuilderObjectFactory;
199-
this.openAPIBuilder = openAPIBuilderObjectFactory.getObject();
199+
this.openAPIService = openAPIBuilderObjectFactory.getObject();
200200
this.requestBuilder = requestBuilder;
201201
this.responseBuilder = responseBuilder;
202202
this.operationParser = operationParser;
@@ -253,44 +253,44 @@ public static void addHiddenRestControllers(String... classes) {
253253
*/
254254
protected synchronized OpenAPI getOpenApi() {
255255
OpenAPI openApi;
256-
if (openAPIBuilder.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
256+
if (openAPIService.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
257257
Instant start = Instant.now();
258-
openAPIBuilder.build();
259-
Map<String, Object> mappingsMap = openAPIBuilder.getMappingsMap().entrySet().stream()
258+
openAPIService.build();
259+
Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
260260
.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
261261
Hidden.class) == null))
262262
.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getClass()))
263263
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
264264

265-
Map<String, Object> findControllerAdvice = openAPIBuilder.getControllerAdviceMap();
265+
Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
266266
// calculate generic responses
267-
openApi = openAPIBuilder.getCalculatedOpenAPI();
267+
openApi = openAPIService.getCalculatedOpenAPI();
268268
if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)) {
269269
if (!CollectionUtils.isEmpty(mappingsMap))
270270
findControllerAdvice.putAll(mappingsMap);
271271
responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice);
272272
}
273273
getPaths(mappingsMap);
274274
if (!CollectionUtils.isEmpty(openApi.getServers()))
275-
openAPIBuilder.setServersPresent(true);
276-
openAPIBuilder.updateServers(openApi);
275+
openAPIService.setServersPresent(true);
276+
openAPIService.updateServers(openApi);
277277

278278
if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
279279
this.removeBrokenReferenceDefinitions(openApi);
280280

281281
// run the optional customisers
282282
openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
283283

284-
openAPIBuilder.setCachedOpenAPI(openApi);
285-
openAPIBuilder.resetCalculatedOpenAPI();
284+
openAPIService.setCachedOpenAPI(openApi);
285+
openAPIService.resetCalculatedOpenAPI();
286286

287287
LOGGER.info("Init duration for springdoc-openapi is: {} ms",
288288
Duration.between(start, Instant.now()).toMillis());
289289
}
290290
else {
291-
if (!CollectionUtils.isEmpty(openAPIBuilder.getCachedOpenAPI().getServers()))
292-
openAPIBuilder.setServersPresent(true);
293-
openApi = openAPIBuilder.updateServers(openAPIBuilder.getCachedOpenAPI());
291+
if (!CollectionUtils.isEmpty(openAPIService.getCachedOpenAPI().getServers()))
292+
openAPIService.setServersPresent(true);
293+
openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI());
294294
}
295295
return openApi;
296296
}
@@ -317,7 +317,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
317317
String[] headers = routerOperation.getHeaders();
318318
Map<String, String> queryParams = routerOperation.getQueryParams();
319319

320-
OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
320+
OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
321321
Components components = openAPI.getComponents();
322322
Paths paths = openAPI.getPaths();
323323

@@ -363,7 +363,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
363363
fillParametersList(operation, queryParams, methodAttributes);
364364

365365
// compute tags
366-
operation = openAPIBuilder.buildTags(handlerMethod, operation, openAPI);
366+
operation = openAPIService.buildTags(handlerMethod, operation, openAPI);
367367

368368
io.swagger.v3.oas.annotations.parameters.RequestBody requestBodyDoc = AnnotatedElementUtils.findMergedAnnotation(method,
369369
io.swagger.v3.oas.annotations.parameters.RequestBody.class);
@@ -413,7 +413,7 @@ private void buildCallbacks(OpenAPI openAPI, MethodAttributes methodAttributes,
413413
* @param routerOperationList the router operation list
414414
*/
415415
protected void calculatePath(List<RouterOperation> routerOperationList) {
416-
ApplicationContext applicationContext = openAPIBuilder.getContext();
416+
ApplicationContext applicationContext = openAPIService.getContext();
417417
if (!CollectionUtils.isEmpty(routerOperationList)) {
418418
Collections.sort(routerOperationList);
419419
for (RouterOperation routerOperation : routerOperationList) {
@@ -466,7 +466,7 @@ protected void calculatePath(RouterOperation routerOperation) {
466466
String[] headers = routerOperation.getHeaders();
467467
Map<String, String> queryParams = routerOperation.getQueryParams();
468468

469-
OpenAPI openAPI = openAPIBuilder.getCalculatedOpenAPI();
469+
OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
470470
Paths paths = openAPI.getPaths();
471471
Map<HttpMethod, Operation> operationMap = null;
472472
if (paths.containsKey(operationPath)) {
@@ -525,7 +525,7 @@ protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVis
525525
}
526526
else {
527527
List<org.springdoc.core.annotations.RouterOperation> routerOperationList = new ArrayList<>();
528-
ApplicationContext applicationContext = openAPIBuilder.getContext();
528+
ApplicationContext applicationContext = openAPIService.getContext();
529529
RouterOperations routerOperations = applicationContext.findAnnotationOnBean(beanName, RouterOperations.class);
530530
if (routerOperations == null) {
531531
org.springdoc.core.annotations.RouterOperation routerOperation = applicationContext.findAnnotationOnBean(beanName, org.springdoc.core.annotations.RouterOperation.class);
@@ -542,7 +542,6 @@ protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVis
542542
calculatePath(operationList);
543543
}
544544
}
545-
546545
}
547546

548547
/**
@@ -850,7 +849,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
850849
List<Parameter> parametersList = operation.getParameters();
851850
if (parametersList == null)
852851
parametersList = new ArrayList<>();
853-
Collection<Parameter> headersMap = AbstractRequestBuilder.getHeaders(methodAttributes, new LinkedHashMap<>());
852+
Collection<Parameter> headersMap = AbstractRequestService.getHeaders(methodAttributes, new LinkedHashMap<>());
854853
parametersList.addAll(headersMap);
855854
if (!CollectionUtils.isEmpty(queryParams)) {
856855
for (Map.Entry<String, String> entry : queryParams.entrySet()) {
@@ -859,7 +858,7 @@ private void fillParametersList(Operation operation, Map<String, String> queryPa
859858
parameter.setSchema(new StringSchema()._default(entry.getValue()));
860859
parameter.setRequired(true);
861860
parameter.setIn(ParameterIn.QUERY.toString());
862-
GenericParameterBuilder.mergeParameter(parametersList, parameter);
861+
GenericParameterService.mergeParameter(parametersList, parameter);
863862
}
864863
operation.setParameters(parametersList);
865864
}
@@ -1003,8 +1002,8 @@ else if (existingOperation != null) {
10031002
* Init open api builder.
10041003
*/
10051004
protected void initOpenAPIBuilder() {
1006-
if (openAPIBuilder.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
1007-
openAPIBuilder = openAPIBuilderObjectFactory.getObject();
1005+
if (openAPIService.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
1006+
openAPIService = openAPIBuilderObjectFactory.getObject();
10081007
}
10091008
}
10101009

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
* The type Abstract request builder.
8686
* @author bnasslahsen
8787
*/
88-
public abstract class AbstractRequestBuilder {
88+
public abstract class AbstractRequestService {
8989

9090
/**
9191
* The constant PARAM_TYPES_TO_IGNORE.
@@ -133,17 +133,17 @@ public abstract class AbstractRequestBuilder {
133133
/**
134134
* The Parameter builder.
135135
*/
136-
private final GenericParameterBuilder parameterBuilder;
136+
private final GenericParameterService parameterBuilder;
137137

138138
/**
139139
* The Request body builder.
140140
*/
141-
private final RequestBodyBuilder requestBodyBuilder;
141+
private final RequestBodyService requestBodyService;
142142

143143
/**
144144
* The Operation builder.
145145
*/
146-
private final OperationBuilder operationBuilder;
146+
private final OperationService operationService;
147147

148148
/**
149149
* The Local spring doc parameter name discoverer.
@@ -159,18 +159,18 @@ public abstract class AbstractRequestBuilder {
159159
* Instantiates a new Abstract request builder.
160160
*
161161
* @param parameterBuilder the parameter builder
162-
* @param requestBodyBuilder the request body builder
163-
* @param operationBuilder the operation builder
162+
* @param requestBodyService the request body builder
163+
* @param operationService the operation builder
164164
* @param parameterCustomizers the parameter customizers
165165
* @param localSpringDocParameterNameDiscoverer the local spring doc parameter name discoverer
166166
*/
167-
protected AbstractRequestBuilder(GenericParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
168-
OperationBuilder operationBuilder, Optional<List<ParameterCustomizer>> parameterCustomizers,
167+
protected AbstractRequestService(GenericParameterService parameterBuilder, RequestBodyService requestBodyService,
168+
OperationService operationService, Optional<List<ParameterCustomizer>> parameterCustomizers,
169169
LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer) {
170170
super();
171171
this.parameterBuilder = parameterBuilder;
172-
this.requestBodyBuilder = requestBodyBuilder;
173-
this.operationBuilder = operationBuilder;
172+
this.requestBodyService = requestBodyService;
173+
this.operationService = operationService;
174174
if (parameterCustomizers.isPresent())
175175
parameterCustomizers.get().removeIf(Objects::isNull);
176176
this.parameterCustomizers = parameterCustomizers;
@@ -220,7 +220,7 @@ public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
220220
public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
221221
Operation operation, MethodAttributes methodAttributes, OpenAPI openAPI) {
222222
// Documentation
223-
String operationId = operationBuilder.getOperationId(handlerMethod.getMethod().getName(),
223+
String operationId = operationService.getOperationId(handlerMethod.getMethod().getName(),
224224
operation.getOperationId(), openAPI);
225225
operation.setOperationId(operationId);
226226
// requests
@@ -258,14 +258,14 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
258258
if (!isParamToIgnore(methodParameter)) {
259259
parameter = buildParams(parameterInfo, components, requestMethod, methodAttributes.getJsonViewAnnotation());
260260
// Merge with the operation parameters
261-
parameter = GenericParameterBuilder.mergeParameter(operationParameters, parameter);
261+
parameter = GenericParameterService.mergeParameter(operationParameters, parameter);
262262
List<Annotation> parameterAnnotations = Arrays.asList(methodParameter.getParameterAnnotations());
263263
if (isValidParameter(parameter))
264264
applyBeanValidatorAnnotations(parameter, parameterAnnotations);
265265
else if (!RequestMethod.GET.equals(requestMethod)) {
266266
if (operation.getRequestBody() != null)
267267
requestBodyInfo.setRequestBody(operation.getRequestBody());
268-
requestBodyBuilder.calculateRequestBodyInfo(components, methodAttributes,
268+
requestBodyService.calculateRequestBodyInfo(components, methodAttributes,
269269
parameterInfo, requestBodyInfo);
270270
applyBeanValidatorAnnotations(requestBodyInfo.getRequestBody(), parameterAnnotations, methodParameter.isOptional());
271271
}
@@ -538,8 +538,8 @@ else if (OPENAPI_STRING_TYPE.equals(schema.getType())) {
538538
*
539539
* @return the request body builder
540540
*/
541-
public RequestBodyBuilder getRequestBodyBuilder() {
542-
return requestBodyBuilder;
541+
public RequestBodyService getRequestBodyBuilder() {
542+
return requestBodyService;
543543
}
544544

545545
/**

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterBuilder.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
* @author bnasslahsen
6060
*/
6161
@SuppressWarnings("rawtypes")
62-
public class GenericParameterBuilder {
62+
public class GenericParameterService {
6363

6464
/**
6565
* The constant FILE_TYPES.
@@ -74,7 +74,7 @@ public class GenericParameterBuilder {
7474
/**
7575
* The constant LOGGER.
7676
*/
77-
private static final Logger LOGGER = LoggerFactory.getLogger(GenericParameterBuilder.class);
77+
private static final Logger LOGGER = LoggerFactory.getLogger(GenericParameterService.class);
7878

7979
static {
8080
FILE_TYPES.add(MultipartFile.class);
@@ -92,7 +92,7 @@ public class GenericParameterBuilder {
9292
* @param propertyResolverUtils the property resolver utils
9393
* @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
9494
*/
95-
public GenericParameterBuilder(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
95+
public GenericParameterService(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
9696
this.propertyResolverUtils = propertyResolverUtils;
9797
this.optionalDelegatingMethodParameterCustomizer=optionalDelegatingMethodParameterCustomizer;
9898
}

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java renamed to springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@
6868
* The type Generic response builder.
6969
* @author bnasslahsen
7070
*/
71-
public class GenericResponseBuilder {
71+
public class GenericResponseService {
7272

7373
/**
7474
* The Operation builder.
7575
*/
76-
private final OperationBuilder operationBuilder;
76+
private final OperationService operationService;
7777

7878
/**
7979
* The Return type parsers.
@@ -98,16 +98,16 @@ public class GenericResponseBuilder {
9898
/**
9999
* Instantiates a new Generic response builder.
100100
*
101-
* @param operationBuilder the operation builder
101+
* @param operationService the operation builder
102102
* @param returnTypeParsers the return type parsers
103103
* @param springDocConfigProperties the spring doc config properties
104104
* @param propertyResolverUtils the property resolver utils
105105
*/
106-
public GenericResponseBuilder(OperationBuilder operationBuilder, List<ReturnTypeParser> returnTypeParsers,
106+
public GenericResponseService(OperationService operationService, List<ReturnTypeParser> returnTypeParsers,
107107
SpringDocConfigProperties springDocConfigProperties,
108108
PropertyResolverUtils propertyResolverUtils) {
109109
super();
110-
this.operationBuilder = operationBuilder;
110+
this.operationService = operationService;
111111
this.returnTypeParsers = returnTypeParsers;
112112
this.springDocConfigProperties = springDocConfigProperties;
113113
this.propertyResolverUtils = propertyResolverUtils;
@@ -155,7 +155,7 @@ public void buildGenericResponse(Components components, Map<String, Object> find
155155
Arrays.stream(objClz.getDeclaredMethods()).filter(m -> m.isAnnotationPresent(ExceptionHandler.class)).forEach(methods::add);
156156
// for each one build ApiResponse and add it to existing responses
157157
for (Method method : methods) {
158-
if (!operationBuilder.isHidden(method)) {
158+
if (!operationService.isHidden(method)) {
159159
RequestMapping reqMappringMethod = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class);
160160
String[] methodProduces = { springDocConfigProperties.getDefaultProducesMediaType() };
161161
if (reqMappringMethod != null)

0 commit comments

Comments
 (0)