Merge pull request #357 from swagger-api/html-body-fix

resolves request body example and adds to htmlDocs template
swagger-api · Apr 9, 2019 · c2cedc7 · c2cedc7
2 parents b489a40 + ae70c1b
commit c2cedc7
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/main/java/io/swagger/codegen/v3/generators/DefaultCodegenConfig.java b/src/main/java/io/swagger/codegen/v3/generators/DefaultCodegenConfig.java
@@ -34,6 +34,7 @@
 import io.swagger.v3.core.util.Yaml;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.examples.Example;
 import io.swagger.v3.oas.models.headers.Header;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.BinarySchema;
@@ -2494,6 +2495,19 @@ public CodegenParameter fromRequestBody(RequestBody body, String name, Schema sc
 
         codegenParameter.jsonSchema = Json.pretty(body);
 
+        if (body.getContent() != null && !body.getContent().isEmpty()) {
+            Object example = new ArrayList<>(body.getContent().values()).get(0).getExample();
+            if (example != null) {
+                codegenParameter.example = Json.pretty(example);
+            } else {
+                Map<String, Example> examples = new ArrayList<>(body.getContent().values()).get(0).getExamples();
+                if (examples != null && !examples.isEmpty()) {
+                    // get the first.. or concat all as json?
+                    codegenParameter.example = Json.pretty(new ArrayList<>(examples.values()).get(0));
+                }
+            }
+        }
+
         if (schema == null) {
             schema = getSchemaFromBody(body);
         }

diff --git a/src/main/resources/handlebars/htmlDocs/bodyParam.mustache b/src/main/resources/handlebars/htmlDocs/bodyParam.mustache
@@ -1,3 +1,4 @@
 {{#is this 'body-param'}}<div class="param">{{baseName}} {{#baseType}}<a href="#{{baseType}}">{{baseType}}</a>{{/baseType}} {{^required}}(optional){{/required}}{{#required}}(required){{/required}}</div>
 
       <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; {{unescapedDescription}} {{#defaultValue}}default: {{{defaultValue}}}{{/defaultValue}}</div>{{/is}}
+      {{#example}}<div class="param-desc"><span class="param-type">example: <code>{{example}}</code></span></div>{{/example}}