com.centurylink.mdw.cli.SwaggerGenerate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mdw-common Show documentation
Show all versions of mdw-common Show documentation
MDW is a microservices based workflow framework
/*
* Copyright (C) 2018 CenturyLink, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.centurylink.mdw.cli;
import static io.swagger.codegen.config.CodegenConfiguratorUtils.applySystemPropertiesKvpList;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import io.airlift.airline.Option;
import io.swagger.codegen.ClientOptInput;
import io.swagger.codegen.CodegenConstants;
import io.swagger.codegen.DefaultGenerator;
import io.swagger.codegen.config.CodegenConfigurator;
/**
* This whole class is reproduced just so we can suppress swagger meta output.
* And also to support --generated-flow-base-package.
*/
public class SwaggerGenerate extends io.swagger.codegen.cmd.Generate {
public static final String GENERATED_FLOW_BASE_PACKAGE = "generatedFlowBasePackage";
public static final String INPUT_API_PACKAGE = "inputApiPackage";
@Option(name = {"-v", "--verbose"}, description = "verbose mode")
private Boolean verbose;
@Option(name = {"-l", "--lang"}, title = "language", required = true,
description = "client language to generate (maybe class name in classpath, required)")
private String lang;
@Option(name = {"-o", "--output"}, title = "output directory",
description = "where to write the generated files (current dir by default)")
private String output = "";
@Option(name = {"-i", "--input-spec"}, title = "spec file", required = true,
description = "location of the swagger spec, as URL or file (required)")
private String spec;
@Option(name = {"-t", "--template-dir"}, title = "template directory",
description = "folder containing the template files")
private String templateDir;
@Option(
name = {"-a", "--auth"},
title = "authorization",
description = "adds authorization headers when fetching the swagger definitions remotely. "
+ "Pass in a URL-encoded string of name:header with a comma separating multiple values")
private String auth;
@Option(
name = {"-D"},
title = "system properties",
description = "sets specified system properties in "
+ "the format of name=value,name=value (or multiple options, each with name=value)")
private List systemProperties = new ArrayList<>();
@Option(
name = {"-c", "--config"},
title = "configuration file",
description = "Path to json configuration file. "
+ "File content should be in a json format {\"optionKey\":\"optionValue\", \"optionKey1\":\"optionValue1\"...} "
+ "Supported options can be different for each language. Run config-help -l {lang} command for language specific config options.")
private String configFile;
@Option(name = {"-s", "--skip-overwrite"}, title = "skip overwrite",
description = "specifies if the existing files should be "
+ "overwritten during the generation.")
private Boolean skipOverwrite;
@Option(name = {"--api-package"}, title = "api package",
description = CodegenConstants.API_PACKAGE_DESC)
private String apiPackage;
@Option(name = {"--model-package"}, title = "model package",
description = CodegenConstants.MODEL_PACKAGE_DESC)
private String modelPackage;
@Option(name = {"--model-name-prefix"}, title = "model name prefix",
description = CodegenConstants.MODEL_NAME_PREFIX_DESC)
private String modelNamePrefix;
@Option(name = {"--model-name-suffix"}, title = "model name suffix",
description = CodegenConstants.MODEL_NAME_SUFFIX_DESC)
private String modelNameSuffix;
@Option(
name = {"--instantiation-types"},
title = "instantiation types",
description = "sets instantiation type mappings in the format of type=instantiatedType,type=instantiatedType."
+ "For example (in Java): array=ArrayList,map=HashMap. In other words array types will get instantiated as ArrayList in generated code."
+ " You can also have multiple occurrences of this option.")
private List instantiationTypes = new ArrayList<>();
@Option(
name = {"--type-mappings"},
title = "type mappings",
description = "sets mappings between swagger spec types and generated code types "
+ "in the format of swaggerType=generatedType,swaggerType=generatedType. For example: array=List,map=Map,string=String."
+ " You can also have multiple occurrences of this option.")
private List typeMappings = new ArrayList<>();
@Option(
name = {"--additional-properties"},
title = "additional properties",
description = "sets additional properties that can be referenced by the mustache templates in the format of name=value,name=value."
+ " You can also have multiple occurrences of this option.")
private List additionalProperties = new ArrayList<>();
@Option(
name = {"--language-specific-primitives"},
title = "language specific primitives",
description = "specifies additional language specific primitive types in the format of type1,type2,type3,type3. For example: String,boolean,Boolean,Double."
+ " You can also have multiple occurrences of this option.")
private List languageSpecificPrimitives = new ArrayList<>();
@Option(
name = {"--import-mappings"},
title = "import mappings",
description = "specifies mappings between a given class and the import that should be used for that class in the format of type=import,type=import."
+ " You can also have multiple occurrences of this option.")
private List importMappings = new ArrayList<>();
@Option(name = {"--invoker-package"}, title = "invoker package",
description = CodegenConstants.INVOKER_PACKAGE_DESC)
private String invokerPackage;
@Option(name = {"--group-id"}, title = "group id", description = CodegenConstants.GROUP_ID_DESC)
private String groupId;
@Option(name = {"--artifact-id"}, title = "artifact id",
description = CodegenConstants.ARTIFACT_ID_DESC)
private String artifactId;
@Option(name = {"--artifact-version"}, title = "artifact version",
description = CodegenConstants.ARTIFACT_VERSION_DESC)
private String artifactVersion;
@Option(name = {"--library"}, title = "library", description = CodegenConstants.LIBRARY_DESC)
private String library;
@Option(name = {"--git-user-id"}, title = "git user id",
description = CodegenConstants.GIT_USER_ID_DESC)
private String gitUserId;
@Option(name = {"--git-repo-id"}, title = "git repo id",
description = CodegenConstants.GIT_REPO_ID_DESC)
private String gitRepoId;
@Option(name = {"--release-note"}, title = "release note",
description = CodegenConstants.RELEASE_NOTE_DESC)
private String releaseNote;
@Option(name = {"--http-user-agent"}, title = "http user agent",
description = CodegenConstants.HTTP_USER_AGENT_DESC)
private String httpUserAgent;
@Option(
name = {"--reserved-words-mappings"},
title = "reserved word mappings",
description = "specifies how a reserved name should be escaped to. Otherwise, the default _ is used. For example id=identifier."
+ " You can also have multiple occurrences of this option.")
private List reservedWordsMappings = new ArrayList<>();
@Option(name = {"--ignore-file-override"}, title = "ignore file override location",
description = CodegenConstants.IGNORE_FILE_OVERRIDE_DESC)
private String ignoreFileOverride;
@Option(name = {"--remove-operation-id-prefix"}, title = "remove prefix of the operationId",
description = CodegenConstants.REMOVE_OPERATION_ID_PREFIX_DESC)
private Boolean removeOperationIdPrefix;
@Option(name = {"--generated-flow-base-package"}, title = "generate microservice orchestration workflow processes with this base package",
description = GENERATED_FLOW_BASE_PACKAGE)
private String generatedFlowBasePackage;
@Option(name = {"--input-api-package"}, title = "consider user entered api package",
description = INPUT_API_PACKAGE)
private String inputApiPackage;
@Override
public void run() {
// attempt to read from config file
CodegenConfigurator configurator = CodegenConfigurator.fromFile(configFile);
// if a config file wasn't specified or we were unable to read it
if (configurator == null) {
// createa a fresh configurator
configurator = new CodegenConfigurator();
}
// now override with any specified parameters
if (verbose != null) {
configurator.setVerbose(verbose);
}
if (skipOverwrite != null) {
configurator.setSkipOverwrite(skipOverwrite);
}
if (spec != null && !spec.isEmpty()) {
configurator.setInputSpec(spec);
}
if (lang != null && !lang.isEmpty()) {
configurator.setLang(lang);
}
if (output != null && !output.isEmpty()) {
configurator.setOutputDir(output);
}
if (auth != null && !auth.isEmpty()) {
configurator.setAuth(auth);
}
if (templateDir != null && !templateDir.isEmpty()) {
configurator.setTemplateDir(templateDir);
}
if (apiPackage != null && !apiPackage.isEmpty()) {
configurator.setApiPackage(apiPackage);
}
if (modelPackage != null && !modelPackage.isEmpty()) {
configurator.setModelPackage(modelPackage);
}
if (modelNamePrefix != null && !modelNamePrefix.isEmpty()) {
configurator.setModelNamePrefix(modelNamePrefix);
}
if (spec != null && !spec.isEmpty()) {
configurator.setModelNameSuffix(modelNameSuffix);
}
if (modelNameSuffix != null && !modelNameSuffix.isEmpty()) {
configurator.setInvokerPackage(invokerPackage);
}
if (groupId != null && !groupId.isEmpty()) {
configurator.setGroupId(groupId);
}
if (artifactId != null && !artifactId.isEmpty()) {
configurator.setArtifactId(artifactId);
}
if (artifactVersion != null && !artifactVersion.isEmpty()) {
configurator.setArtifactVersion(artifactVersion);
}
if (library != null && !library.isEmpty()) {
configurator.setLibrary(library);
}
if (gitUserId != null && !gitUserId.isEmpty()) {
configurator.setGitUserId(gitUserId);
}
if (gitRepoId != null && !gitRepoId.isEmpty()) {
configurator.setGitRepoId(gitRepoId);
}
if (releaseNote != null && !releaseNote.isEmpty()) {
configurator.setReleaseNote(releaseNote);
}
if (httpUserAgent != null && !httpUserAgent.isEmpty()) {
configurator.setHttpUserAgent(httpUserAgent);
}
if (ignoreFileOverride != null && !ignoreFileOverride.isEmpty()) {
configurator.setIgnoreFileOverride(ignoreFileOverride);
}
if (removeOperationIdPrefix != null) {
configurator.setRemoveOperationIdPrefix(removeOperationIdPrefix);
}
Map addlProps = new LinkedHashMap<>();
if (generatedFlowBasePackage != null) {
addlProps.put(GENERATED_FLOW_BASE_PACKAGE, generatedFlowBasePackage);
}
if (inputApiPackage != null) {
addlProps.put(INPUT_API_PACKAGE, inputApiPackage);
}
if (!addlProps.isEmpty()) {
configurator.setAdditionalProperties(addlProps);
}
applySystemPropertiesKvpList(systemProperties, configurator);
final ClientOptInput clientOptInput = configurator.toClientOptInput();
DefaultGenerator generator = new DefaultGenerator();
generator.setGenerateSwaggerMetadata(false);
generator.opts(clientOptInput).generate();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy