loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Enable Tag details to be used in templates (#5455)

Browse Source 
* Enable Tag details to be used in templates

Adds the ability to reference the tag name, description, external
docs, and vendor extensions in Mustache templates during codegen

* Properly resolve tags when not defined in Swagger tags definition
This commit is contained in:
nbruno 2017-04-25 11:07:59 -04:00 committed by wing328
parent 2dd051fd4e
commit aef25ffdc3
4 changed files with 268 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenOperation.java
View File

@ -1,6 +1,7 @@
package io.swagger.codegen;
import io.swagger.models.ExternalDocs;
import io.swagger.models.Tag;
import java.util.ArrayList;
import java.util.HashSet;
@ -28,7 +29,7 @@ public class CodegenOperation {
public List<CodegenParameter> headerParams = new ArrayList<CodegenParameter>();
public List<CodegenParameter> formParams = new ArrayList<CodegenParameter>();
public List<CodegenSecurity> authMethods;
public List<String> tags;
public List<Tag> tags;
public List<CodegenResponse> responses = new ArrayList<CodegenResponse>();
public Set<String> imports = new HashSet<String>();
public List<Map<String, String>> examples;

1
modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java
View File

@ -1965,7 +1965,6 @@ public class DefaultCodegen {
op.summary = escapeText(operation.getSummary());
op.unescapedNotes = operation.getDescription();
op.notes = escapeText(operation.getDescription());
op.tags = operation.getTags();
op.hasConsumes = false;
op.hasProduces = false;

41
modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultGenerator.java
View File

@ -751,11 +751,37 @@ public class DefaultGenerator extends AbstractGenerator implements Generator {
if (System.getProperty("debugOperations") != null) {
LOGGER.info("processOperation: resourcePath= " + resourcePath + "\t;" + httpMethod + " " + operation + "\n");
}
List<String> tags = operation.getTags();
if (tags == null) {
tags = new ArrayList<String>();
tags.add("default");
List<Tag> tags = new ArrayList<Tag>();
List<String> tagNames = operation.getTags();
List<Tag> swaggerTags = swagger.getTags();
if (tagNames != null) {
if (swaggerTags == null) {
for (String tagName : tagNames) {
tags.add(new Tag().name(tagName));
}
} else {
for (String tagName : tagNames) {
boolean foundTag = false;
for (Tag tag : swaggerTags) {
if (tag.getName().equals(tagName)) {
tags.add(tag);
foundTag = true;
break;
}
}
if (!foundTag) {
tags.add(new Tag().name(tagName));
}
}
}
}
if (tags.isEmpty()) {
tags.add(new Tag().name("default"));
}
/*
build up a set of parameter "ids" defined at the operation level
per the swagger 2.0 spec "A unique parameter is defined by a combination of a name and location"
@ -778,12 +804,11 @@ public class DefaultGenerator extends AbstractGenerator implements Generator {
}
}
for (String tag : tags) {
for (Tag tag : tags) {
try {
CodegenOperation codegenOperation = config.fromOperation(resourcePath, httpMethod, operation, swagger.getDefinitions(), swagger);
codegenOperation.tags = new ArrayList<String>();
codegenOperation.tags.add(config.sanitizeTag(tag));
config.addOperationToGroup(config.sanitizeTag(tag), resourcePath, operation, codegenOperation, operations);
codegenOperation.tags = new ArrayList<Tag>(tags);
config.addOperationToGroup(config.sanitizeTag(tag.getName()), resourcePath, operation, codegenOperation, operations);
List<Map<String, List<String>>> securities = operation.getSecurity();
if (securities == null && swagger.getSecurity() != null) {

237
modules/swagger-codegen/src/test/java/io/swagger/codegen/DefaultGeneratorTest.java
View File

@ -1,7 +1,9 @@
package io.swagger.codegen;
import io.swagger.codegen.languages.JavaClientCodegen;
import io.swagger.models.ExternalDocs;
import io.swagger.models.Swagger;
import io.swagger.models.Tag;
import io.swagger.parser.SwaggerParser;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
@ -14,10 +16,7 @@ import java.io.*;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.*;
import static io.swagger.codegen.CodegenConstants.TEMPLATE_DIR;
import static java.nio.charset.StandardCharsets.UTF_8;
@ -281,6 +280,236 @@ public class DefaultGeneratorTest {
}
}
@Test
public void testResolveTagsAgainstSwaggerTagsDefinition() {
final File output = folder.getRoot();
String spec =
"swagger: '2.0'\n" +
"info:\n" +
" version: 1.0.0\n" +
" title: Swagger Petstore\n" +
"tags:\n" +
" - name: pet\n" +
" description: Everything about your Pets\n" +
" externalDocs:\n" +
" description: Find out more\n" +
" url: 'http://swagger.io'\n" +
" x-vendor-ext: 'tag'\n" +
" - name: store\n" +
" description: Access to Petstore orders\n" +
" - name: user\n" +
" description: Operations about user\n" +
" externalDocs:\n" +
" x-vendor-ext: 'foo'\n" +
"paths:\n" +
" /pet:\n" +
" get:\n" +
" tags:\n" +
" - pet\n" +
" - store\n" +
" - user\n" +
" responses:\n" +
" '200':\n" +
" description: OK";
final List<Tag> expectedTags = new ArrayList<Tag>();
expectedTags.add(new Tag().name("pet").description("Everything about your Pets").externalDocs(new ExternalDocs().description("Find out more").url("http://swagger.io")));
expectedTags.add(new Tag().name("store").description("Access to Petstore orders"));
expectedTags.add(new Tag().name("user").description("Operations about user").externalDocs(new ExternalDocs()));
expectedTags.get(0).getVendorExtensions().put("x-vendor-ext", "tag");
expectedTags.get(2).getExternalDocs().getVendorExtensions().put("x-vendor-ext", "foo");
final Swagger swagger = new SwaggerParser().readWithInfo(spec).getSwagger();
CodegenConfig codegenConfig = new JavaClientCodegen();
codegenConfig.setOutputDir(output.getAbsolutePath());
ClientOptInput clientOptInput = new ClientOptInput().opts(new ClientOpts()).swagger(swagger).config(codegenConfig);
DefaultGenerator generator = new DefaultGenerator();
generator.opts(clientOptInput);
Map<String, List<CodegenOperation>> paths = generator.processPaths(swagger.getPaths());
assertEquals(3, paths.size());
List<String> sanitizedTags = Arrays.asList("Pet", "Store", "User");
for (String tag : sanitizedTags) {
List<CodegenOperation> operations = paths.get(tag);
assertNotNull(operations);
for (CodegenOperation operation : operations) {
assertOperationHasTags(operation, expectedTags);
}
}
}
@Test
public void testResolveTagsNoSwaggerTagsDefinition() {
final File output = folder.getRoot();
String spec =
"swagger: '2.0'\n" +
"info:\n" +
" version: 1.0.0\n" +
" title: Swagger Petstore\n" +
"paths:\n" +
" /pet:\n" +
" get:\n" +
" tags:\n" +
" - pet\n" +
" - store\n" +
" - user\n" +
" responses:\n" +
" '200':\n" +
" description: OK";
final List<Tag> expectedTags = new ArrayList<Tag>();
expectedTags.add(new Tag().name("pet"));
expectedTags.add(new Tag().name("store"));
expectedTags.add(new Tag().name("user"));
final Swagger swagger = new SwaggerParser().readWithInfo(spec).getSwagger();
CodegenConfig codegenConfig = new JavaClientCodegen();
codegenConfig.setOutputDir(output.getAbsolutePath());
ClientOptInput clientOptInput = new ClientOptInput().opts(new ClientOpts()).swagger(swagger).config(codegenConfig);
DefaultGenerator generator = new DefaultGenerator();
generator.opts(clientOptInput);
Map<String, List<CodegenOperation>> paths = generator.processPaths(swagger.getPaths());
assertEquals(3, paths.size());
List<String> sanitizedTags = Arrays.asList("Pet", "Store", "User");
for (String tag : sanitizedTags) {
List<CodegenOperation> operations = paths.get(tag);
assertNotNull(operations);
for (CodegenOperation operation : operations) {
assertOperationHasTags(operation, expectedTags);
}
}
}
@Test
public void testResolveTagsNoTagsDefined() {
final File output = folder.getRoot();
String spec =
"swagger: '2.0'\n" +
"info:\n" +
" version: 1.0.0\n" +
" title: Swagger Petstore\n" +
"paths:\n" +
" /pet:\n" +
" get:\n" +
" responses:\n" +
" '200':\n" +
" description: OK";
final List<Tag> expectedTags = new ArrayList<Tag>();
expectedTags.add(new Tag().name("default"));
final Swagger swagger = new SwaggerParser().readWithInfo(spec).getSwagger();
CodegenConfig codegenConfig = new JavaClientCodegen();
codegenConfig.setOutputDir(output.getAbsolutePath());
ClientOptInput clientOptInput = new ClientOptInput().opts(new ClientOpts()).swagger(swagger).config(codegenConfig);
DefaultGenerator generator = new DefaultGenerator();
generator.opts(clientOptInput);
Map<String, List<CodegenOperation>> paths = generator.processPaths(swagger.getPaths());
assertEquals(1, paths.size());
List<String> sanitizedTags = Collections.singletonList("Default");
for (String tag : sanitizedTags) {
List<CodegenOperation> operations = paths.get(tag);
assertNotNull(operations);
for (CodegenOperation operation : operations) {
assertOperationHasTags(operation, expectedTags);
}
}
}
@Test
public void testResolveTagNotDefinedInSwaggerTagsDefinition() {
final File output = folder.getRoot();
String spec =
"swagger: '2.0'\n" +
"info:\n" +
" version: 1.0.0\n" +
" title: Swagger Petstore\n" +
"tags:\n" +
" - name: pet\n" +
" description: Everything about your Pets\n" +
"paths:\n" +
" /pet:\n" +
" get:\n" +
" tags:\n" +
" - pet\n" +
" - store\n" + // Not defined above
" - user\n" + // Not defined above
" responses:\n" +
" '200':\n" +
" description: OK";
final List<Tag> expectedTags = new ArrayList<Tag>();
expectedTags.add(new Tag().name("pet").description("Everything about your Pets"));
expectedTags.add(new Tag().name("store"));
expectedTags.add(new Tag().name("user"));
final Swagger swagger = new SwaggerParser().readWithInfo(spec).getSwagger();
CodegenConfig codegenConfig = new JavaClientCodegen();
codegenConfig.setOutputDir(output.getAbsolutePath());
ClientOptInput clientOptInput = new ClientOptInput().opts(new ClientOpts()).swagger(swagger).config(codegenConfig);
DefaultGenerator generator = new DefaultGenerator();
generator.opts(clientOptInput);
Map<String, List<CodegenOperation>> paths = generator.processPaths(swagger.getPaths());
assertEquals(3, paths.size());
List<String> sanitizedTags = Arrays.asList("Pet", "Store", "User");
for (String tag : sanitizedTags) {
List<CodegenOperation> operations = paths.get(tag);
assertNotNull(operations);
for (CodegenOperation operation : operations) {
assertOperationHasTags(operation, expectedTags);
}
}
}
private void assertOperationHasTags(CodegenOperation op, List<Tag> expectedTags) {
assertNotNull(op.tags);
assertEquals(op.tags.size(), expectedTags.size());
for (Tag tag : expectedTags) {
Tag foundTag = null;
for (Tag opTag : op.tags) {
if (tag.getName().equals(opTag.getName())) {
foundTag = opTag;
break;
}
}
if (foundTag == null) {
fail("Expected tag '" + tag.getName() + "' was not found on operation " + op.operationId);
}
assertEquals(tag, foundTag);
if (!tag.getVendorExtensions().isEmpty()) {
assertEquals(tag.getVendorExtensions(), foundTag.getVendorExtensions());
}
if (tag.getExternalDocs() != null && !tag.getExternalDocs().getVendorExtensions().isEmpty()) {
assertEquals(tag.getExternalDocs().getVendorExtensions(), foundTag.getExternalDocs().getVendorExtensions());
}
}
}
private static void changeContent(File file) throws IOException {
Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), UTF_8));
out.write(TEST_SKIP_OVERWRITE);