refs #4455 - add config properties for default response status code

swagger-api · Sep 26, 2023 · fab5000 · fab5000
1 parent 9048843
commit fab5000
Show file tree

Hide file tree

Showing 15 changed files with 145 additions and 16 deletions.
diff --git a/modules/swagger-gradle-plugin/README.md b/modules/swagger-gradle-plugin/README.md
@@ -96,7 +96,7 @@ Parameter | Description | Required | Default
 `modelConverterClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 `contextId`|see [Context](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#context)|false|
 `outputPath`|**DEPRECATED** output path where file(s) are saved|false|
-
+`defaultResponseCode`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 
 **Note** parameter `openApiFile` corresponds to [config](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties) openAPI. It points to a location of a file in YAML or JSON format representing the input spec that will be merged with the resolved spec. Typically used to add Info section, or any other meta data.
 An example of such file:
@@ -122,3 +122,4 @@ Since version 2.1.6, `sortOutput` parameter is available, allowing to sort objec
 Since version 2.1.6, `objectMapperProcessorClass` allows to configure also the ObjectMapper instance used to serialize the resolved OpenAPI
 Since version 2.1.9, `alwaysResolveAppPath` parameter is available, allowing to trigger resolving of Application Path from annotation also not in runtime (e.g. using servlet in separate application, or in maven plugin at build time, etc)
 Since version 2.1.15, `skipResolveAppPath` parameter is available, allowing to skip resolving of Application Path from annotation
+Since version 2.2.17, `defaultResponseCode` parameter is available, allowing to set the code used when resolving responses with no http status code annotation
diff --git a/...s/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java b/...s/swagger-gradle-plugin/src/main/java/io/swagger/v3/plugins/gradle/tasks/ResolveTask.java
@@ -77,6 +77,8 @@ public enum Format {JSON, YAML, JSONANDYAML};
 
     private Boolean convertToOpenAPI31 = false;
 
+    private String defaultResponseCode;
+
     @Input
     @Optional
     public String getOutputFileName() {
@@ -227,6 +229,22 @@ public void setObjectMapperProcessorClass(String objectMapperProcessorClass) {
         this.objectMapperProcessorClass = objectMapperProcessorClass;
     }
 
+    /**
+     * @since 2.2.17
+     */
+    @Input
+    @Optional
+    public String getDefaultResponseCode() {
+        return defaultResponseCode;
+    }
+
+    /**
+     * @since 2.2.17
+     */
+    public void setDefaultResponseCode(String defaultResponseCode) {
+        this.defaultResponseCode = defaultResponseCode;
+    }
+
     /**
      * @since 2.0.6
      */
@@ -461,6 +479,11 @@ public void resolve() throws GradleException {
                 method.invoke(swaggerLoader, objectMapperProcessorClass);
             }
 
+            if (StringUtils.isNotBlank(defaultResponseCode)) {
+                method=swaggerLoaderClass.getDeclaredMethod("setDefaultResponseCode",String.class);
+                method.invoke(swaggerLoader, defaultResponseCode);
+            }
+
             method=swaggerLoaderClass.getDeclaredMethod("setPrettyPrint", Boolean.class);
             method.invoke(swaggerLoader, prettyPrint);
 

diff --git a/...wagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java b/...wagger-integration/src/main/java/io/swagger/v3/oas/integration/GenericOpenApiContext.java
@@ -630,6 +630,9 @@ private OpenAPIConfiguration mergeParentConfiguration(OpenAPIConfiguration confi
         if (merged.isConvertToOpenAPI31() == null) {
             merged.setConvertToOpenAPI31(parentConfig.isConvertToOpenAPI31());
         }
+        if (merged.getDefaultResponseCode() == null) {
+            merged.setDefaultResponseCode(parentConfig.getDefaultResponseCode());
+        }
 
         return merged;
     }

diff --git a/...swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java b/...swagger-integration/src/main/java/io/swagger/v3/oas/integration/SwaggerConfiguration.java
@@ -40,6 +40,22 @@ public class SwaggerConfiguration implements OpenAPIConfiguration {
 
     private Boolean convertToOpenAPI31;
 
+    @Override
+    public String getDefaultResponseCode() {
+        return defaultResponseCode;
+    }
+
+    public void setDefaultResponseCode(String defaultResponseCode) {
+        this.defaultResponseCode = defaultResponseCode;
+    }
+
+    public SwaggerConfiguration defaultResponseCode(String defaultResponseCode) {
+        this.defaultResponseCode = defaultResponseCode;
+        return this;
+    }
+
+    private String defaultResponseCode;
+
     public Long getCacheTTL() {
         return cacheTTL;
     }

diff --git a/...ger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java b/...ger-integration/src/main/java/io/swagger/v3/oas/integration/api/OpenAPIConfiguration.java
@@ -63,4 +63,9 @@ public interface OpenAPIConfiguration {
      * @since 2.2.12
      */
     Boolean isConvertToOpenAPI31();
+
+    /**
+     * @since 2.2.17
+     */
+    public String getDefaultResponseCode();
 }
diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/OperationParser.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/OperationParser.java
@@ -62,10 +62,10 @@ public static Optional<RequestBody> getRequestBody(io.swagger.v3.oas.annotations
     }
 
     public static Optional<ApiResponses> getApiResponses(final io.swagger.v3.oas.annotations.responses.ApiResponse[] responses, Produces classProduces, Produces methodProduces, Components components, JsonView jsonViewAnnotation) {
-        return getApiResponses(responses, classProduces, methodProduces, components, jsonViewAnnotation, false);
+        return getApiResponses(responses, classProduces, methodProduces, components, jsonViewAnnotation, false, ApiResponses.DEFAULT);
     }
 
-    public static Optional<ApiResponses> getApiResponses(final io.swagger.v3.oas.annotations.responses.ApiResponse[] responses, Produces classProduces, Produces methodProduces, Components components, JsonView jsonViewAnnotation, boolean openapi31) {
+    public static Optional<ApiResponses> getApiResponses(final io.swagger.v3.oas.annotations.responses.ApiResponse[] responses, Produces classProduces, Produces methodProduces, Components components, JsonView jsonViewAnnotation, boolean openapi31, String defaultResponseKey) {
         if (responses == null) {
             return Optional.empty();
         }
@@ -103,7 +103,7 @@ public static Optional<ApiResponses> getApiResponses(final io.swagger.v3.oas.ann
                 if (StringUtils.isNotBlank(response.responseCode())) {
                     apiResponsesObject.addApiResponse(response.responseCode(), apiResponseObject);
                 } else {
-                    apiResponsesObject._default(apiResponseObject);
+                    apiResponsesObject.addApiResponse(defaultResponseKey, apiResponseObject);
                 }
             }
         }

diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java
@@ -88,6 +88,8 @@ public class Reader implements OpenApiReader {
     private Paths paths;
     private Set<Tag> openApiTags;
 
+    private String defaultResponseKey = ApiResponses.DEFAULT;
+
     private static final String GET_METHOD = "get";
     private static final String POST_METHOD = "post";
     private static final String PUT_METHOD = "put";
@@ -216,6 +218,7 @@ public void setConfiguration(OpenAPIConfiguration openApiConfiguration) {
                     this.components = this.openAPI.getComponents();
                 }
             }
+            this.defaultResponseKey = StringUtils.isBlank(config.getDefaultResponseCode()) ? ApiResponses.DEFAULT : config.getDefaultResponseCode();
         }
     }
 
@@ -1083,7 +1086,9 @@ protected Operation parseMethod(
                     classProduces,
                     methodProduces,
                     components,
-                    jsonViewAnnotation
+                    jsonViewAnnotation,
+                    config.isOpenAPI31(),
+                    defaultResponseKey
             ).ifPresent(responses -> {
                 if (operation.getResponses() == null) {
                     operation.setResponses(responses);
@@ -1104,7 +1109,9 @@ protected Operation parseMethod(
                     classProduces,
                     methodProduces,
                     components,
-                    jsonViewAnnotation
+                    jsonViewAnnotation,
+                    config.isOpenAPI31(),
+                    defaultResponseKey
             ).ifPresent(responses -> {
                 if (operation.getResponses() == null) {
                     operation.setResponses(responses);
@@ -1164,20 +1171,20 @@ protected Operation parseMethod(
                         methodProduces == null ? new String[0] : methodProduces.value(), content, mediaType);
                 if (operation.getResponses() == null) {
                     operation.responses(
-                            new ApiResponses()._default(
+                            new ApiResponses().addApiResponse(defaultResponseKey,
                                     new ApiResponse().description(DEFAULT_DESCRIPTION)
                                             .content(content)
                             )
                     );
                 }
-                if (operation.getResponses().getDefault() != null &&
-                        StringUtils.isBlank(operation.getResponses().getDefault().get$ref())) {
-                    if (operation.getResponses().getDefault().getContent() == null) {
-                        operation.getResponses().getDefault().content(content);
+                if (operation.getResponses().get(defaultResponseKey) != null &&
+                        StringUtils.isBlank(operation.getResponses().get(defaultResponseKey).get$ref())) {
+                    if (operation.getResponses().get(defaultResponseKey).getContent() == null) {
+                        operation.getResponses().get(defaultResponseKey).content(content);
                     } else {
-                        for (String key : operation.getResponses().getDefault().getContent().keySet()) {
-                            if (operation.getResponses().getDefault().getContent().get(key).getSchema() == null) {
-                                operation.getResponses().getDefault().getContent().get(key).setSchema(returnTypeSchema);
+                        for (String key : operation.getResponses().get(defaultResponseKey).getContent().keySet()) {
+                            if (operation.getResponses().get(defaultResponseKey).getContent().get(key).getSchema() == null) {
+                                operation.getResponses().get(defaultResponseKey).getContent().get(key).setSchema(returnTypeSchema);
                             }
                         }
                     }
@@ -1414,7 +1421,7 @@ protected void setOperationObjectFromApiOperationAnnotation(
             AnnotationsUtils.getExternalDocumentation(apiOperation.externalDocs(), openapi31).ifPresent(operation::setExternalDocs);
         }
 
-        OperationParser.getApiResponses(apiOperation.responses(), classProduces, methodProduces, components, jsonViewAnnotation, openapi31).ifPresent(responses -> {
+        OperationParser.getApiResponses(apiOperation.responses(), classProduces, methodProduces, components, jsonViewAnnotation, openapi31, defaultResponseKey).ifPresent(responses -> {
             if (operation.getResponses() == null) {
                 operation.setResponses(responses);
             } else {

diff --git a/...gger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java b/...gger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletConfigContextUtils.java
@@ -46,6 +46,11 @@ public class ServletConfigContextUtils {
      */
     public static final String OPENAPI_CONFIGURATION_OBJECT_MAPPER_PROCESSOR_KEY = "openApi.configuration.objectMapperProcessorClass";
 
+    /**
+     * @since 2.2.17
+     */
+    public static final String OPENAPI_CONFIGURATION_DEFAULT_RESPONSE_CODE_KEY = "openApi.configuration.defaultResponseCode";
+
     /**
      * @since 2.0.6
      */

diff --git a/...rs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java b/...rs2/src/main/java/io/swagger/v3/jaxrs2/integration/ServletOpenApiConfigurationLoader.java
@@ -17,6 +17,7 @@
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_CACHE_TTL_KEY;
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_FILTER_KEY;
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_OBJECT_MAPPER_PROCESSOR_KEY;
+import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_DEFAULT_RESPONSE_CODE_KEY;
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_OPENAPI_31_KEY;
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_CONVERT_TO_OPENAPI_31_KEY;
 import static io.swagger.v3.jaxrs2.integration.ServletConfigContextUtils.OPENAPI_CONFIGURATION_PRETTYPRINT_KEY;
@@ -65,6 +66,7 @@ public OpenAPIConfiguration load(String path) throws IOException {
                     .cacheTTL(getLongInitParam(servletConfig, OPENAPI_CONFIGURATION_CACHE_TTL_KEY))
                     .scannerClass(getInitParam(servletConfig, OPENAPI_CONFIGURATION_SCANNER_KEY))
                     .objectMapperProcessorClass(getInitParam(servletConfig, OPENAPI_CONFIGURATION_OBJECT_MAPPER_PROCESSOR_KEY))
+                    .defaultResponseCode(getInitParam(servletConfig, OPENAPI_CONFIGURATION_DEFAULT_RESPONSE_CODE_KEY))
                     .openAPI31(getBooleanInitParam(servletConfig, OPENAPI_CONFIGURATION_OPENAPI_31_KEY))
                     .convertToOpenAPI31(getBooleanInitParam(servletConfig, OPENAPI_CONFIGURATION_CONVERT_TO_OPENAPI_31_KEY))
                     .modelConverterClasses(resolveModelConverterClasses(servletConfig));
@@ -138,6 +140,9 @@ public boolean exists(String path) {
             if (getInitParam(servletConfig, OPENAPI_CONFIGURATION_OBJECT_MAPPER_PROCESSOR_KEY) != null) {
                 return true;
             }
+            if (getInitParam(servletConfig, OPENAPI_CONFIGURATION_DEFAULT_RESPONSE_CODE_KEY) != null) {
+                return true;
+            }
             if (getInitParam(servletConfig, OPENAPI_CONFIGURATION_CONVERT_TO_OPENAPI_31_KEY) != null) {
                 return true;
             }

diff --git a/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java b/modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/SwaggerLoader.java
@@ -36,6 +36,7 @@ public class SwaggerLoader {
     private String openapiAsString;
 
     private String objectMapperProcessorClass;
+    private String defaultResponseCode;
     private String modelConverterClasses;
 
     private Boolean sortOutput = false;
@@ -62,6 +63,20 @@ public void setObjectMapperProcessorClass(String objectMapperProcessorClass) {
         this.objectMapperProcessorClass = objectMapperProcessorClass;
     }
 
+    /**
+     * @since 2.2.17
+     */
+    public String getDefaultResponseCode() {
+        return defaultResponseCode;
+    }
+
+    /**
+     * @since 2.2.17
+     */
+    public void setDefaultResponseCode(String defaultResponseCode) {
+        this.defaultResponseCode = defaultResponseCode;
+    }
+
     /**
      * @since 2.0.6
      */
@@ -279,6 +294,7 @@ public Map<String, String> resolve() throws Exception{
                 .resourceClasses(resourceClassesSet)
                 .resourcePackages(resourcePackagesSet)
                 .objectMapperProcessorClass(objectMapperProcessorClass)
+                .defaultResponseCode(defaultResponseCode)
                 .modelConverterClasses(modelConverterSet)
                 .sortOutput(sortOutput)
                 .alwaysResolveAppPath(alwaysResolveAppPath)

diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java
@@ -15,6 +15,7 @@
 import io.swagger.v3.jaxrs2.matchers.SerializationMatchers;
 import io.swagger.v3.jaxrs2.petstore31.PetResource;
 import io.swagger.v3.jaxrs2.petstore31.TagResource;
+import io.swagger.v3.jaxrs2.resources.DefaultResponseResource;
 import io.swagger.v3.jaxrs2.resources.Misc31Resource;
 import io.swagger.v3.jaxrs2.resources.ParameterMaximumValueResource;
 import io.swagger.v3.jaxrs2.resources.ResponseReturnTypeResource;
@@ -3148,6 +3149,27 @@ public void testResponseReturnType() {
         SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
     }
 
+    @Test(description = "Responses Default Status")
+    public void testResponseDefaultStatus() {
+        SwaggerConfiguration config = new SwaggerConfiguration().defaultResponseCode("200");
+        Reader reader = new Reader(config);
+
+        OpenAPI openAPI = reader.read(DefaultResponseResource.class);
+        String yaml = "openapi: 3.0.1\n" +
+                "paths:\n" +
+                "  /:\n" +
+                "    get:\n" +
+                "      operationId: test\n" +
+                "      responses:\n" +
+                "        \"200\":\n" +
+                "          description: default response\n" +
+                "          content:\n" +
+                "            '*/*':\n" +
+                "              schema:\n" +
+                "                type: string\n";
+        SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
+    }
+
     @Test
     public void test4412PathWildcards() {
         Reader reader = new Reader(new OpenAPI());

diff --git a/.../swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/DefaultResponseResource.java b/.../swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/DefaultResponseResource.java
@@ -0,0 +1,14 @@
+package io.swagger.v3.jaxrs2.resources;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+
+public class DefaultResponseResource {
+
+    @GET
+    @Path("/")
+    public String test() {
+        return null;
+    }
+
+}
diff --git a/modules/swagger-maven-plugin/README.md b/modules/swagger-maven-plugin/README.md
@@ -197,6 +197,7 @@ Parameter | Description | Required | Default
 `readAllResources`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 `ignoredRoutes`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 `objectMapperProcessorClass`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
+`defaultResponseCode`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 `modelConverterClasses`|see [configuration property](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#configuration-properties)|false|
 `contextId`|see [Context](https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Integration-and-Configuration#context)|false|${project.artifactId}
 
@@ -208,3 +209,4 @@ Since version 2.1.6, `sortOutput` parameter is available, allowing to sort objec
 Since version 2.1.6, `objectMapperProcessorClass` allows to configure also the ObjectMapper instance used to serialize the resolved OpenAPI
 Since version 2.1.9, `alwaysResolveAppPath` parameter is available, allowing to trigger resolving of Application Path from annotaion also not in runtime (e.g. using servlet in separate application, or in maven plugin at build time, etc)
 Since version 2.1.15, `skipResolveAppPath` parameter is available, allowing to skip resolving of Application Path from annotation
+Since version 2.2.17, `defaultResponseCode` parameter is available, allowing to set the code used when resolving responses with no http status code annotation
diff --git a/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java b/modules/swagger-maven-plugin/src/main/java/io/swagger/v3/plugin/maven/SwaggerMojo.java
@@ -345,6 +345,9 @@ private SwaggerConfiguration mergeConfig(OpenAPI openAPIInput, SwaggerConfigurat
         if (StringUtils.isNotBlank(objectMapperProcessorClass)) {
             config.objectMapperProcessorClass(objectMapperProcessorClass);
         }
+        if (StringUtils.isNotBlank(defaultResponseCode)) {
+            config.defaultResponseCode(defaultResponseCode);
+        }
         if (isCollectionNotBlank(modelConverterClasses)) {
             config.modelConverterClasses(modelConverterClasses);
         }
@@ -385,6 +388,11 @@ private boolean isCollectionNotBlank(Collection<?> collection) {
      */
     @Parameter( property = "resolve.objectMapperProcessorClass" )
     private String objectMapperProcessorClass;
+    /**
+     * @since 2.2.17
+     */
+    @Parameter( property = "resolve.defaultResponseCode" )
+    private String defaultResponseCode;
     @Parameter(property = "resolve.prettyPrint")
     private Boolean prettyPrint;
     @Parameter(property = "resolve.readAllResources")

diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/responses/ApiResponses.java
@@ -28,15 +28,17 @@ public ApiResponses addApiResponse(String name, ApiResponse item) {
      *
      * @return ApiResponse _default
      **/
-
+    @Deprecated
     public ApiResponse getDefault() {
         return this.get(DEFAULT);
     }
 
+    @Deprecated
     public void setDefault(ApiResponse _default) {
         addApiResponse(DEFAULT, _default);
     }
 
+    @Deprecated
     public ApiResponses _default(ApiResponse _default) {
         setDefault(_default);
         return this;