Skip to content

Commit d0710e6

Browse files
bnasslahsenbnasslahsen
committed
Merge branch 'add-router-operation-customizer' of github.com:hyeonisism/springdoc-openapi into hyeonisism-add-router-operation-customizer
2 parents c355bc8 + a1a9b96 commit d0710e6

File tree

26 files changed

+460
-40
lines changed

26 files changed

+460
-40
lines changed

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

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@
8585
import org.springdoc.core.customizers.OpenApiCustomiser;
8686
import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
8787
import org.springdoc.core.customizers.OperationCustomizer;
88+
import org.springdoc.core.customizers.RouterOperationCustomizer;
8889
import org.springdoc.core.filters.OpenApiMethodFilter;
8990
import org.springdoc.core.fn.AbstractRouterFunctionVisitor;
9091
import org.springdoc.core.fn.RouterFunctionData;
@@ -120,6 +121,7 @@
120121
* The type Abstract open api resource.
121122
* @author bnasslahsen
122123
* @author kevinraddatz
124+
* @author hyeonisism
123125
*/
124126
public abstract class AbstractOpenApiResource extends SpecFilter {
125127

@@ -178,6 +180,11 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
178180
*/
179181
private final Optional<List<OperationCustomizer>> operationCustomizers;
180182

183+
/**
184+
* The RouterOperation customizers.
185+
*/
186+
private final Optional<List<RouterOperationCustomizer>> routerOperationCustomizers;
187+
181188
/**
182189
* The method filters to use.
183190
*/
@@ -217,6 +224,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
217224
* @param operationParser the operation parser
218225
* @param operationCustomizers the operation customizers
219226
* @param openApiCustomisers the open api customisers
227+
* @param routerOperationCustomizers the router operation customisers
220228
* @param methodFilters the method filters
221229
* @param springDocConfigProperties the spring doc config properties
222230
* @param springDocProviders the spring doc providers
@@ -226,6 +234,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
226234
GenericResponseService responseBuilder, OperationService operationParser,
227235
Optional<List<OperationCustomizer>> operationCustomizers,
228236
Optional<List<OpenApiCustomiser>> openApiCustomisers,
237+
Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
229238
Optional<List<OpenApiMethodFilter>> methodFilters,
230239
SpringDocConfigProperties springDocConfigProperties, SpringDocProviders springDocProviders) {
231240
super();
@@ -236,6 +245,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
236245
this.responseBuilder = responseBuilder;
237246
this.operationParser = operationParser;
238247
this.openApiCustomisers = openApiCustomisers;
248+
this.routerOperationCustomizers = routerOperationCustomizers;
239249
this.methodFilters = methodFilters;
240250
this.springDocProviders = springDocProviders;
241251
//add the default customizers
@@ -368,6 +378,9 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
368378
*/
369379
protected void calculatePath(HandlerMethod handlerMethod,
370380
RouterOperation routerOperation, Locale locale, OpenAPI openAPI) {
381+
382+
routerOperation = customiseRouterOperation(routerOperation, handlerMethod);
383+
371384
String operationPath = routerOperation.getPath();
372385
Set<RequestMethod> requestMethods = new HashSet<>(Arrays.asList(routerOperation.getMethods()));
373386
io.swagger.v3.oas.annotations.Operation apiOperation = routerOperation.getOperation();
@@ -595,12 +608,15 @@ protected void calculatePath(RouterOperation routerOperation, Locale locale, Ope
595608
* @param consumes the consumes
596609
* @param produces the produces
597610
* @param headers the headers
611+
* @param params the params
598612
* @param locale the locale
599613
* @param openAPI the open api
600614
*/
601615
protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
602-
Set<RequestMethod> requestMethods, String[] consumes, String[] produces, String[] headers, Locale locale, OpenAPI openAPI) {
603-
this.calculatePath(handlerMethod, new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers), locale, openAPI);
616+
Set<RequestMethod> requestMethods, String[] consumes, String[] produces, String[] headers, String[] params, Locale locale, OpenAPI openAPI) {
617+
this.calculatePath(handlerMethod,
618+
new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers, params),
619+
locale, openAPI);
604620
}
605621

606622
/**
@@ -781,7 +797,6 @@ public static boolean containsResponseBody(HandlerMethod handlerMethod) {
781797
return responseBodyAnnotation != null;
782798
}
783799

784-
785800
/**
786801
* Is rest controller boolean.
787802
*
@@ -836,6 +851,22 @@ protected Operation customiseOperation(Operation operation, HandlerMethod handle
836851
return operation;
837852
}
838853

854+
/**
855+
* Customise router operation
856+
* @param routerOperation
857+
* @param handlerMethod
858+
* @return the router operation
859+
*/
860+
protected RouterOperation customiseRouterOperation(RouterOperation routerOperation, HandlerMethod handlerMethod) {
861+
if (routerOperationCustomizers.isPresent()) {
862+
List<RouterOperationCustomizer> routerOperationCustomizerList = routerOperationCustomizers.get();
863+
for (RouterOperationCustomizer routerOperationCustomizer : routerOperationCustomizerList) {
864+
routerOperation = routerOperationCustomizer.customize(routerOperation, handlerMethod);
865+
}
866+
}
867+
return routerOperation;
868+
}
869+
839870
/**
840871
* Merge routers.
841872
*

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GroupedOpenApi.java‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import org.apache.commons.lang3.StringUtils;
3232
import org.springdoc.core.customizers.OpenApiCustomiser;
3333
import org.springdoc.core.customizers.OperationCustomizer;
34+
import org.springdoc.core.customizers.RouterOperationCustomizer;
3435
import org.springdoc.core.filters.OpenApiMethodFilter;
3536

3637
import org.springframework.util.CollectionUtils;
@@ -58,6 +59,11 @@ public class GroupedOpenApi {
5859
*/
5960
private List<OperationCustomizer> operationCustomizers;
6061

62+
/**
63+
* The Router Operation customizers.
64+
*/
65+
private List<RouterOperationCustomizer> routerOperationCustomizers;
66+
6167
/**
6268
* The Paths to match.
6369
*/
@@ -120,6 +126,7 @@ private GroupedOpenApi(Builder builder) {
120126
this.displayName = StringUtils.defaultIfEmpty(builder.displayName, this.group);
121127
this.openApiCustomisers = Objects.requireNonNull(builder.openApiCustomisers);
122128
this.operationCustomizers = Objects.requireNonNull(builder.operationCustomizers);
129+
this.routerOperationCustomizers = Objects.requireNonNull(builder.routerOperationCustomizers);
123130
this.openApiMethodFilters = Objects.requireNonNull(builder.methodFilters);
124131
if (CollectionUtils.isEmpty(this.pathsToMatch)
125132
&& CollectionUtils.isEmpty(this.packagesToScan)
@@ -242,6 +249,15 @@ public List<OpenApiMethodFilter> getOpenApiMethodFilters() {
242249
return openApiMethodFilters;
243250
}
244251

252+
/**
253+
* Gets router operation customizers.
254+
*
255+
* @return the router operation customizers
256+
*/
257+
public List<RouterOperationCustomizer> getRouterOperationCustomizers() {
258+
return routerOperationCustomizers;
259+
}
260+
245261
/**
246262
* Gets display name.
247263
*
@@ -266,6 +282,11 @@ public static class Builder {
266282
*/
267283
private final List<OperationCustomizer> operationCustomizers = new ArrayList<>();
268284

285+
/**
286+
* The Router Operation customizers.
287+
*/
288+
private final List<RouterOperationCustomizer> routerOperationCustomizers = new ArrayList<>();
289+
269290
/**
270291
* The methods filters to apply.
271292
*/
@@ -433,6 +454,17 @@ public Builder addOperationCustomizer(OperationCustomizer operationCustomizer) {
433454
return this;
434455
}
435456

457+
/**
458+
* Add router operation customizer builder
459+
*
460+
* @param routerOperationCustomizer the router operation customizer
461+
* @return the builder
462+
*/
463+
public Builder addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer) {
464+
this.routerOperationCustomizers.add(routerOperationCustomizer);
465+
return this;
466+
}
467+
436468
/**
437469
* Add method filter.
438470
*

‎springdoc-openapi-common/src/main/java/org/springdoc/core/annotations/RouterOperation.java‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
*
4040
* @author bnasslahsen
4141
*/
42-
@Target({ ElementType.TYPE, ElementType.METHOD})
42+
@Target({ ElementType.TYPE, ElementType.METHOD })
4343
@Retention(RetentionPolicy.RUNTIME)
4444
@Inherited
4545
public @interface RouterOperation {
@@ -95,6 +95,14 @@
9595
*/
9696
String[] headers() default {};
9797

98+
/**
99+
* The parameters of the mapped request, narrowing the primary mapping.
100+
* Same format for any environment: a sequence of "myParam=myValue" style expressions,
101+
* with a request only mapped if each such parameter is found to have the given value.
102+
* @return the string [ ]
103+
*/
104+
String[] params() default {};
105+
98106
/**
99107
* The class of the Handler bean.
100108
* @return the class of the Bean

‎springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/RouterOperationCustomizer.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package org.springdoc.core.customizers;
2+
3+
import org.springdoc.core.fn.RouterOperation;
4+
5+
import org.springframework.web.method.HandlerMethod;
6+
7+
/**
8+
* Implement and register a bean of type {@link RouterOperationCustomizer} to customize an router operation
9+
* based on the handler method input on default OpenAPI descriptions but not groups
10+
*
11+
* @author hyeonisism
12+
*/
13+
@FunctionalInterface
14+
public interface RouterOperationCustomizer {
15+
16+
/**
17+
* Customize router operation.
18+
*
19+
* @param routerOperation input operation
20+
* @param handlerMethod original handler method
21+
* @return customized router operation
22+
*/
23+
RouterOperation customize(RouterOperation routerOperation, HandlerMethod handlerMethod);
24+
25+
}

‎springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterFunctionData.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ public class RouterFunctionData {
6262
*/
6363
private List<String> headers = new ArrayList<>();
6464

65+
/**
66+
* The Params.
67+
*/
68+
private List<String> params = new ArrayList<>();
69+
6570
/**
6671
* The Query params.
6772
*/
@@ -93,6 +98,7 @@ public RouterFunctionData(String nestedOrPath, RouterFunctionData functionData)
9398
this.consumes = Arrays.asList(functionData.getConsumes());
9499
this.produces = Arrays.asList(functionData.getProduces());
95100
this.headers = Arrays.asList(functionData.getHeaders());
101+
this.params = Arrays.asList(functionData.getParams());
96102
this.queryParams = functionData.getQueryParams();
97103
this.methods = functionData.getMethods();
98104
this.attributes = functionData.getAttributes();
@@ -181,6 +187,20 @@ public String[] getConsumes() {
181187
return consumes.toArray(new String[consumes.size()]);
182188
}
183189

190+
/**
191+
* Get params string [ ].
192+
*
193+
* @return the string [ ]
194+
*/
195+
public String[] getParams() { return params.toArray(new String[params.size()]); }
196+
197+
/**
198+
* Add params.
199+
*
200+
* @param params the params
201+
*/
202+
public void addParams(String params) { if(StringUtils.isNotBlank(params)) this.params.add(params); }
203+
184204
/**
185205
* Add consumes.
186206
*

‎springdoc-openapi-common/src/main/java/org/springdoc/core/fn/RouterOperation.java‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
/**
3939
* The type Router operation.
4040
* @author bnasslahsen
41+
* @author hyeonisism
4142
*/
4243
public class RouterOperation implements Comparable<RouterOperation> {
4344

@@ -66,6 +67,11 @@ public class RouterOperation implements Comparable<RouterOperation> {
6667
*/
6768
private String[] headers;
6869

70+
/**
71+
* The Params.
72+
*/
73+
private String[] params;
74+
6975
/**
7076
* The Bean class.
7177
*/
@@ -116,6 +122,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
116122
this.parameterTypes = routerOperationAnnotation.parameterTypes();
117123
this.operation = routerOperationAnnotation.operation();
118124
this.headers = routerOperationAnnotation.headers();
125+
this.params = routerOperationAnnotation.params();
119126
}
120127

121128
/**
@@ -134,6 +141,7 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
134141
this.parameterTypes = routerOperationAnnotation.parameterTypes();
135142
this.operation = routerOperationAnnotation.operation();
136143
this.headers = ArrayUtils.isEmpty(routerOperationAnnotation.headers()) ? routerFunctionData.getHeaders() : routerOperationAnnotation.headers();
144+
this.params = routerOperationAnnotation.params();
137145
this.queryParams = routerFunctionData.getQueryParams();
138146
}
139147

@@ -146,12 +154,13 @@ public RouterOperation(org.springdoc.core.annotations.RouterOperation routerOper
146154
* @param produces the produces
147155
* @param headers the headers
148156
*/
149-
public RouterOperation(String path, RequestMethod[] methods,String[] consumes, String[] produces, String[] headers) {
157+
public RouterOperation(String path, RequestMethod[] methods, String[] consumes, String[] produces, String[] headers, String[] params) {
150158
this.path = path;
151159
this.methods = methods;
152-
this.consumes=consumes;
153-
this.produces=produces;
154-
this.headers=headers;
160+
this.consumes = consumes;
161+
this.produces = produces;
162+
this.headers = headers;
163+
this.params = params;
155164
}
156165

157166
/**
@@ -165,6 +174,7 @@ public RouterOperation(RouterFunctionData routerFunctionData) {
165174
this.consumes = routerFunctionData.getConsumes();
166175
this.produces = routerFunctionData.getProduces();
167176
this.headers = routerFunctionData.getHeaders();
177+
this.params = routerFunctionData.getParams();
168178
this.queryParams = routerFunctionData.getQueryParams();
169179

170180
Map<String, Object> attributes = routerFunctionData.getAttributes();
@@ -369,6 +379,24 @@ public void setQueryParams(Map<String, String> queryParams) {
369379
this.queryParams = queryParams;
370380
}
371381

382+
/**
383+
* Gets params.
384+
*
385+
* @return the params
386+
*/
387+
public String[] getParams() {
388+
return this.params;
389+
}
390+
391+
/**
392+
* Sets params.
393+
*
394+
* @param params
395+
*/
396+
public void setParams(String[] params) {
397+
this.params = params;
398+
}
399+
372400
/**
373401
* Gets operation model.
374402
*

0 commit comments

Comments
 (0)