Added support for extensions on @apiresponse. Fixes #368

Author: bnasslahsen

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [UnReleased] -
+## Added
+- Added ability to disable security for one operation using  @SecurityRequirements #259
+- Support for extensions on @ApiResponse #368
 
 ## [1.2.28] -
 ## Changed

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractResponseBuilder.java

@@ -152,6 +152,9 @@ private Map<String, ApiResponse> computeResponse(Components components, Method m
 				io.swagger.v3.oas.annotations.media.Content[] contentdoc = apiResponseAnnotations.content();
 				buildContentFromDoc(components, apiResponsesOp, methodAttributes,
 						apiResponseAnnotations, apiResponse, contentdoc);
+				Map<String, Object> extensions = AnnotationsUtils.getExtensions(apiResponseAnnotations.extensions());
+				if (!CollectionUtils.isEmpty(extensions))
+					apiResponse.extensions(extensions);
 				AnnotationsUtils.getHeaders(apiResponseAnnotations.headers(), methodAttributes.getJsonViewAnnotation())
 						.ifPresent(apiResponse::headers);
 				apiResponsesOp.addApiResponse(apiResponseAnnotations.responseCode(), apiResponse);

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java

@@ -123,7 +123,6 @@ private static void addEncodingToMediaType(JsonView jsonViewAnnotation, MediaTyp
 
 	private static void addExtension(io.swagger.v3.oas.annotations.media.Content annotationContent,
 			MediaType mediaType) {
-		annotationContent.extensions();
 		if (annotationContent.extensions().length > 0) {
 			Map<String, Object> extensions = AnnotationsUtils.getExtensions(annotationContent.extensions());
 			extensions.forEach(mediaType::addExtension);

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app77/HelloController.java

@@ -0,0 +1,50 @@
+/*
+ *
+ *  * Copyright 2019-2020 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 test.org.springdoc.api.app77;
+
+import javax.validation.Valid;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.extensions.Extension;
+import io.swagger.v3.oas.annotations.extensions.ExtensionProperty;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import org.hibernate.validator.constraints.NotBlank;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+
+@RestController
+public class HelloController {
+
+	@ApiResponse(content = @Content(schema = @Schema(type = "string")), extensions = @Extension(properties = @ExtensionProperty(name = "x-is-file", value = "true")))
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @NotBlank String name) {
+
+	}
+
+
+	@Operation(responses = @ApiResponse(content = @Content(schema = @Schema(type = "string")), extensions = @Extension(properties = @ExtensionProperty(name = "x-is-file", value = "true"))))	@GetMapping(value = "/persons2")
+	public void persons2(@Valid @NotBlank String name) {
+
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app77/SpringDocApp77Test.java

@@ -0,0 +1,29 @@
+/*
+ *
+ *  * Copyright 2019-2020 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 test.org.springdoc.api.app77;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp77Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app77.json

@@ -0,0 +1,78 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/persons2": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "persons2",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "x-is-file": "true"
+          }
+        }
+      }
+    },
+    "/persons": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "persons",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "x-is-file": "true"
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}