Skip to content

Commit 0b51a68

Browse files
bnasslahsenbnasslahsen
authored
Merge pull request #1814 from okohub/feature-get-with-body
Allow requestBody creation for GET on openapi resource endpoint
2 parents 8fa89e0 + 3d3e327 commit 0b51a68

File tree

6 files changed

+208
-7
lines changed

6 files changed

+208
-7
lines changed

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
import org.apache.commons.lang3.ArrayUtils;
6565
import org.apache.commons.lang3.StringUtils;
6666
import org.apache.commons.lang3.reflect.FieldUtils;
67+
import org.springdoc.core.SpringDocConfigProperties.ApiDocs.OpenApiVersion;
6768
import org.springdoc.core.customizers.ParameterCustomizer;
6869
import org.springdoc.core.providers.JavadocProvider;
6970

@@ -291,7 +292,8 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
291292
}
292293

293294
if (!isParamToIgnore(methodParameter)) {
294-
parameter = buildParams(parameterInfo, components, requestMethod, methodAttributes.getJsonViewAnnotation());
295+
parameter = buildParams(parameterInfo, components, requestMethod, methodAttributes.getJsonViewAnnotation(),
296+
openAPI.getOpenapi());
295297
// Merge with the operation parameters
296298
parameter = GenericParameterService.mergeParameter(operationParameters, parameter);
297299
List<Annotation> parameterAnnotations = Arrays.asList(methodParameter.getParameterAnnotations());
@@ -305,7 +307,7 @@ public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
305307
}
306308
applyBeanValidatorAnnotations(parameter, parameterAnnotations);
307309
}
308-
else if (!RequestMethod.GET.equals(requestMethod)) {
310+
else if (!RequestMethod.GET.equals(requestMethod) || OpenApiVersion.OPENAPI_3_1.getVersion().equals(openAPI.getOpenapi())) {
309311
if (operation.getRequestBody() != null)
310312
requestBodyInfo.setRequestBody(operation.getRequestBody());
311313
requestBodyService.calculateRequestBodyInfo(components, methodAttributes,
@@ -494,10 +496,11 @@ public boolean isValidParameter(Parameter parameter) {
494496
* @param components the components
495497
* @param requestMethod the request method
496498
* @param jsonView the json view
499+
* @param openApiVersion the open api version
497500
* @return the parameter
498501
*/
499502
public Parameter buildParams(ParameterInfo parameterInfo, Components components,
500-
RequestMethod requestMethod, JsonView jsonView) {
503+
RequestMethod requestMethod, JsonView jsonView, String openApiVersion) {
501504
MethodParameter methodParameter = parameterInfo.getMethodParameter();
502505
if (parameterInfo.getParamType() != null) {
503506
if (!ValueConstants.DEFAULT_NONE.equals(parameterInfo.getDefaultValue()))
@@ -507,7 +510,7 @@ public Parameter buildParams(ParameterInfo parameterInfo, Components components,
507510
return this.buildParam(parameterInfo, components, jsonView);
508511
}
509512
// By default
510-
if (!isRequestBodyParam(requestMethod, parameterInfo)) {
513+
if (!isRequestBodyParam(requestMethod, parameterInfo, openApiVersion)) {
511514
parameterInfo.setRequired(!((DelegatingMethodParameter) methodParameter).isNotRequired() && !methodParameter.isOptional());
512515
//parameterInfo.setParamType(QUERY_PARAM);
513516
parameterInfo.setDefaultValue(null);
@@ -721,13 +724,15 @@ private void applyValidationsToSchema(Map<String, Annotation> annos, Schema<?> s
721724
*
722725
* @param requestMethod the request method
723726
* @param parameterInfo the parameter info
727+
* @param openApiVersion the open api version
724728
* @return the boolean
725729
*/
726-
private boolean isRequestBodyParam(RequestMethod requestMethod, ParameterInfo parameterInfo) {
730+
private boolean isRequestBodyParam(RequestMethod requestMethod, ParameterInfo parameterInfo, String openApiVersion) {
727731
MethodParameter methodParameter = parameterInfo.getMethodParameter();
728732
DelegatingMethodParameter delegatingMethodParameter = (DelegatingMethodParameter) methodParameter;
733+
Boolean isBodyAllowed = !RequestMethod.GET.equals(requestMethod) || OpenApiVersion.OPENAPI_3_1.getVersion().equals(openApiVersion);
729734

730-
return (!RequestMethod.GET.equals(requestMethod) && (parameterInfo.getParameterModel() == null || parameterInfo.getParameterModel().getIn() == null) && !delegatingMethodParameter.isParameterObject())
735+
return (isBodyAllowed && (parameterInfo.getParameterModel() == null || parameterInfo.getParameterModel().getIn() == null) && !delegatingMethodParameter.isParameterObject())
731736
&&
732737
((methodParameter.getParameterAnnotation(io.swagger.v3.oas.annotations.parameters.RequestBody.class) != null
733738
|| methodParameter.getParameterAnnotation(org.springframework.web.bind.annotation.RequestBody.class) != null

‎springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/core/DataRestRequestService.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ else if (methodParameter.getParameterAnnotation(BackendId.class) != null) {
173173
parameterInfo.setParameterModel(parameter);
174174
}
175175
if (!ArrayUtils.isEmpty(methodParameter.getParameterAnnotations()))
176-
parameter = requestBuilder.buildParams(parameterInfo, openAPI.getComponents(), requestMethod, null);
176+
parameter = requestBuilder.buildParams(parameterInfo, openAPI.getComponents(), requestMethod, null,
177+
openAPI.getOpenapi());
177178

178179
addParameters(openAPI, requestMethod, methodAttributes, operation, methodParameter, parameterInfo, parameter);
179180
}

‎springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v31/app6/DummyData.java‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * * Copyright 2019-2022 the original author or authors.
6+
* * * *
7+
* * * * Licensed under the Apache License, Version 2.0 (the "License");
8+
* * * * you may not use this file except in compliance with the License.
9+
* * * * You may obtain a copy of the License at
10+
* * * *
11+
* * * * https://www.apache.org/licenses/LICENSE-2.0
12+
* * * *
13+
* * * * Unless required by applicable law or agreed to in writing, software
14+
* * * * distributed under the License is distributed on an "AS IS" BASIS,
15+
* * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
* * * * See the License for the specific language governing permissions and
17+
* * * * limitations under the License.
18+
* * *
19+
* *
20+
*
21+
*/
22+
23+
package test.org.springdoc.api.v31.app6;
24+
25+
import java.time.Instant;
26+
27+
public class DummyData {
28+
29+
String trackerId;
30+
31+
Instant timestamp;
32+
33+
Double value;
34+
35+
public String getTrackerId() {
36+
return trackerId;
37+
}
38+
39+
public void setTrackerId(String trackerId) {
40+
this.trackerId = trackerId;
41+
}
42+
43+
public Instant getTimestamp() {
44+
return timestamp;
45+
}
46+
47+
public void setTimestamp(Instant timestamp) {
48+
this.timestamp = timestamp;
49+
}
50+
51+
public Double getValue() {
52+
return value;
53+
}
54+
55+
public void setValue(Double value) {
56+
this.value = value;
57+
}
58+
}

‎springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v31/app6/GetBodyController.java‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * * Copyright 2019-2022 the original author or authors.
6+
* * * *
7+
* * * * Licensed under the Apache License, Version 2.0 (the "License");
8+
* * * * you may not use this file except in compliance with the License.
9+
* * * * You may obtain a copy of the License at
10+
* * * *
11+
* * * * https://www.apache.org/licenses/LICENSE-2.0
12+
* * * *
13+
* * * * Unless required by applicable law or agreed to in writing, software
14+
* * * * distributed under the License is distributed on an "AS IS" BASIS,
15+
* * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
* * * * See the License for the specific language governing permissions and
17+
* * * * limitations under the License.
18+
* * *
19+
* *
20+
*
21+
*/
22+
23+
package test.org.springdoc.api.v31.app6;
24+
25+
import org.springframework.web.bind.annotation.GetMapping;
26+
import org.springframework.web.bind.annotation.RequestBody;
27+
import org.springframework.web.bind.annotation.RestController;
28+
import test.org.springdoc.api.v31.app4.TrackerData;
29+
30+
@RestController
31+
public class GetBodyController {
32+
33+
@GetMapping(value = "/get/body")
34+
DummyData getBody(@RequestBody DummyData dummyData) {
35+
return dummyData;
36+
37+
}
38+
39+
}

‎springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v31/app6/SpringDocApp6Test.java‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * * Copyright 2019-2022 the original author or authors.
6+
* * * *
7+
* * * * Licensed under the Apache License, Version 2.0 (the "License");
8+
* * * * you may not use this file except in compliance with the License.
9+
* * * * You may obtain a copy of the License at
10+
* * * *
11+
* * * * https://www.apache.org/licenses/LICENSE-2.0
12+
* * * *
13+
* * * * Unless required by applicable law or agreed to in writing, software
14+
* * * * distributed under the License is distributed on an "AS IS" BASIS,
15+
* * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
* * * * See the License for the specific language governing permissions and
17+
* * * * limitations under the License.
18+
* * *
19+
* *
20+
*
21+
*/
22+
23+
package test.org.springdoc.api.v31.app6;
24+
25+
import org.springframework.boot.autoconfigure.SpringBootApplication;
26+
import test.org.springdoc.api.v31.AbstractSpringDocV31Test;
27+
28+
public class SpringDocApp6Test extends AbstractSpringDocV31Test {
29+
30+
@SpringBootApplication
31+
static class SpringDocTestApp {
32+
33+
}
34+
}

‎springdoc-openapi-webmvc-core/src/test/resources/results/3.1.0/app6.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"openapi": "3.1.0",
3+
"info": {
4+
"title": "OpenAPI definition",
5+
"version": "v0"
6+
},
7+
"servers": [
8+
{
9+
"url": "http://localhost",
10+
"description": "Generated server url"
11+
}
12+
],
13+
"paths": {
14+
"/get/body": {
15+
"get": {
16+
"tags": [
17+
"get-body-controller"
18+
],
19+
"operationId": "getBody",
20+
"requestBody": {
21+
"content": {
22+
"application/json": {
23+
"schema": {
24+
"$ref": "#/components/schemas/DummyData"
25+
}
26+
}
27+
},
28+
"required": true
29+
},
30+
"responses": {
31+
"200": {
32+
"description": "OK",
33+
"content": {
34+
"*/*": {
35+
"schema": {
36+
"$ref": "#/components/schemas/DummyData"
37+
}
38+
}
39+
}
40+
}
41+
}
42+
}
43+
}
44+
},
45+
"components": {
46+
"schemas": {
47+
"DummyData": {
48+
"properties": {
49+
"trackerId": {
50+
"type": "string"
51+
},
52+
"timestamp": {
53+
"type": "string",
54+
"format": "date-time"
55+
},
56+
"value": {
57+
"type": "number",
58+
"format": "double"
59+
}
60+
}
61+
}
62+
}
63+
}
64+
}

0 commit comments

Comments
 (0)