added 2 sample configs; adsjuted to only generate examples for application/json

Author: GlobeDaBoarder

bin/configs/spring-boot-api-response-examples.yaml

@@ -0,0 +1,13 @@
+generatorName: spring
+outputDir: samples/server/petstore/springboot-api-response-examples
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/api-response-examples_issue17610.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: springboot-api-response-examples
+  documentationProvider: springdoc
+  useSpringBoot3: true
+  java8: true
+  delegatePattern: true
+  useBeanValidation: true
+  hideGenerationTimestamp: "true"

bin/configs/spring-boot-petstore-with-api-response-examples.yaml

@@ -0,0 +1,13 @@
+generatorName: spring
+outputDir: samples/server/petstore/springboot-petstore-with-api-response-examples
+library: spring-boot
+inputSpec: modules/openapi-generator/src/test/resources/3_0/spring/petstore_with_api_response_examples.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+additionalProperties:
+  artifactId: springboot-petstore-with-api-response-examples
+  documentationProvider: springdoc
+  useSpringBoot3: true
+  java8: true
+  delegatePattern: true
+  useBeanValidation: true
+  hideGenerationTimestamp: "true"

modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ExamplesUtils.java

@@ -34,15 +34,20 @@ public static Map<String, Example> getExamplesFromResponse(OpenAPI openAPI, ApiR
     }
 
     private static Map<String, Example> getExamplesFromContent(Content content) {
-        if (content == null || content.isEmpty()) {
+        if (content == null || content.isEmpty())
             return Collections.emptyMap();
+
+        if (content.containsKey("application/json")) {
+            Map<String, Example> examples = content.get("application/json").getExamples();
+            if (content.size() > 1 && examples != null && !examples.isEmpty())
+                once(LOGGER).warn("More than one content media types found in response. Only response examples of the application/json will be taken for codegen.");
+
+            return examples;
         }
-        Map.Entry<String, MediaType> entry = content.entrySet().iterator().next();
-        if (content.size() > 1) {
-            once(LOGGER).debug("Multiple API response examples found in the OAS 'content' section, returning only the first one ({})",
-                    entry.getKey());
-        }
-        return entry.getValue().getExamples();
+
+        once(LOGGER).warn("No application/json content media type found in response. Response examples can only be generated for application/json media type.");
+
+        return Collections.emptyMap();
     }
 
 
@@ -68,10 +73,10 @@ public static List<Map<String, Object>> unaliasExamples(OpenAPI openapi, Map<Str
                 Object exampleValue;
                 if(example.getValue().get$ref() != null){
                     exampleValue = actualComponentsExamples.get(exampleName).getValue();
-                    LOGGER.trace("Unaliased example value from components examples: {}", exampleValue);
+                    LOGGER.debug("Unaliased example value from components examples: {}", exampleValue);
                 } else {
                     exampleValue = example.getValue().getValue();
-                    LOGGER.trace("Retrieved example value directly from the api response example definition: {}", exampleValue);
+                    LOGGER.debug("Retrieved example value directly from the api response example definition: {}", exampleValue);
                 }
 
                 exampleRepr.put("exampleName", exampleName);

modules/openapi-generator/src/main/resources/JavaSpring/api.mustache

@@ -172,7 +172,7 @@ public interface {{classname}} {
             {{#responses}}
             @ApiResponse(responseCode = {{#isDefault}}"default"{{/isDefault}}{{^isDefault}}"{{{code}}}"{{/isDefault}}, description = "{{{message}}}"{{#baseType}}, content = {
                 {{#produces}}
-                @Content(mediaType = "{{{mediaType}}}", {{#isArray}}array = @ArraySchema({{/isArray}}schema = @Schema(implementation = {{{baseType}}}.class){{#isArray}}){{/isArray}}{{^examples.0}}{{#-last}}){{/-last}}{{^-last}}),{{/-last}}{{/examples.0}}{{#examples.0}}, examples = {
+                @Content(mediaType = "{{{mediaType}}}", {{#isArray}}array = @ArraySchema({{/isArray}}schema = @Schema(implementation = {{{baseType}}}.class){{#isArray}}){{/isArray}}{{^isJson}}{{#-last}}){{/-last}}{{^-last}}),{{/-last}}{{/isJson}}{{#isJson}}{{^examples.0}}{{#-last}}){{/-last}}{{^-last}}),{{/-last}}{{/examples.0}}{{#examples.0}}, examples = {
                 {{#examples}}
                     @ExampleObject(
                         name = "{{{exampleName}}}",
@@ -184,7 +184,7 @@ public interface {{classname}} {
                 {{/-last}}
                 {{^-last}}
                 }),
-                {{/-last}}{{/examples.0}}
+                {{/-last}}{{/examples.0}}{{/isJson}}
                 {{/produces}}
             }{{/baseType}}){{^-last}},{{/-last}}
             {{/responses}}