Skip to content

Makes examples available in the templates #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2021
Merged

Makes examples available in the templates #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions boat-scaffold/src/main/java/com/backbase/oss/codegen/BoatStaticDocsGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

import com.backbase.oss.codegen.doc.BoatCodegenParameter;
import com.backbase.oss.codegen.doc.BoatCodegenResponse;
import com.backbase.oss.codegen.doc.BoatExample;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.node.ArrayNode;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.examples.Example;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.parameters.RequestBody;
Expand All @@ -21,10 +23,7 @@

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.*;
import java.util.stream.Collectors;

@Slf4j
Expand Down Expand Up @@ -65,6 +64,13 @@ public void preprocessOpenAPI(OpenAPI openAPI) {
.collect(Collectors.toList()));
}

if (openAPI.getComponents().getExamples() != null) {
Set<String> imports = new HashSet<>();
additionalProperties.put("examples", openAPI.getComponents().getExamples().entrySet().stream()
.map(exampleEntry -> mapComponentExample(imports, exampleEntry))
.collect(Collectors.toList()));
}

if (openAPI.getPaths() != null)
// Ensure single tags for operations
openAPI.getPaths().forEach((path, pathItem) ->
Expand All @@ -84,6 +90,12 @@ private CodegenParameter mapComponentRequestBody(Set<String> imports, java.util.
return fromRequestBody(requestBody, imports, name);
}

private BoatExample mapComponentExample(Set<String> imports, Map.Entry<String, Example> namedExample) {
String key = namedExample.getKey();
Example example = namedExample.getValue();
return new BoatExample(key,"", example , false);
}

private CodegenParameter mapComponentParameter(Set<String> imports, java.util.Map.Entry<String, Parameter> nameParameter) {
Parameter parameter = nameParameter.getValue();
return fromParameter(parameter, imports);
Expand Down
7 changes: 7 additions & 0 deletions boat-scaffold/src/main/templates/boat-marina/api.js.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const data = {
appDescription: {{json appDescription}},
operations: [],
models: {},
examples: {},
requestBodies: {},
responses: {},
parameters: {},
Expand All @@ -28,6 +29,12 @@ const data = {
{{/with}}
{{/each}}

{{#each examples as |example|}}
{{#with example}}
data.examples["{{name}}"] = {{json .}}
{{/with}}
{{/each}}

{{#each requestBodies}}
data["requestBodies"]["{{baseName}}"] = {{{jsonSchema}}};
{{/each}}
Expand Down