io.swagger.codegen

Class DefaultCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

Direct Known Subclasses:

AbstractTypeScriptClientCodegen, AkkaScalaClientCodegen, AndroidClientCodegen, AsyncScalaClientCodegen, CSharpClientCodegen, CsharpDotNet2ClientCodegen, DartClientCodegen, FlashClientCodegen, JavaClientCodegen, NodeJSServerCodegen, ObjcClientCodegen, PerlClientCodegen, PhpClientCodegen, PythonClientCodegen, Qt5CPPGenerator, RubyClientCodegen, ScalaClientCodegen, ScalatraServerCodegen, SilexServerCodegen, SinatraServerCodegen, StaticDocCodegen, StaticHtmlGenerator, SwaggerGenerator, SwaggerYamlGenerator, SwiftCodegen, TizenClientCodegen

public class DefaultCodegen
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	additionalProperties
protected String	apiPackage
protected Map<String,String>	apiTemplateFiles
protected List<CliOption>	cliOptions
protected Set<String>	defaultIncludes
protected String	fileSuffix
protected Map<String,String>	importMapping
protected Map<String,String>	instantiationTypes
protected Set<String>	languageSpecificPrimitives
protected String	library
protected static org.slf4j.Logger	LOGGER
protected String	modelPackage
protected Map<String,String>	modelTemplateFiles
protected String	outputFolder
protected Set<String>	reservedWords
protected boolean	skipOverwrite
protected Boolean	sortParamsByRequiredFlag
protected Map<String,String>	supportedLibraries
protected List<SupportingFile>	supportingFiles
protected boolean	supportsInheritance
protected String	templateDir
protected Map<String,String>	typeMapping

Constructor Summary

Constructors

Constructor and Description
DefaultCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	additionalProperties()
void	addOperationToGroup(String tag, String resourcePath, io.swagger.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
String	apiFileFolder()
String	apiFilename(String templateName, String tag)
String	apiPackage()
Map<String,String>	apiTemplateFiles()
protected CliOption	buildLibraryCliOption(Map<String,String> supportedLibraries)
static String	camelize(String word)
static String	camelize(String word, boolean lowercaseFirstLetter)
List<CliOption>	cliOptions()
Set<String>	defaultIncludes()
String	escapeReservedWord(String name)
String	escapeText(String input)
String	fileSuffix()
CodegenModel	fromModel(String name, io.swagger.models.Model model)
CodegenModel	fromModel(String name, io.swagger.models.Model model, Map<String,io.swagger.models.Model> allDefinitions)
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions)
CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions, io.swagger.models.Swagger swagger)
CodegenParameter	fromParameter(io.swagger.models.parameters.Parameter param, Set<String> imports)
CodegenProperty	fromProperty(String name, io.swagger.models.properties.Property p)
CodegenResponse	fromResponse(String responseCode, io.swagger.models.Response response)
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)
String	generateExamplePath(String path, io.swagger.models.Operation operation)
String	getLibrary() Library template (sub-template).
String	getOutputDir()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
String	getterAndSetterCapitalize(String name)
String	getTypeDeclaration(io.swagger.models.properties.Property p)
String	getTypeDeclaration(String name)
Map<String,String>	importMapping()
String	initialCaps(String name)
Map<String,String>	instantiationTypes()
boolean	isSkipOverwrite()
Set<String>	languageSpecificPrimitives()
String	modelFileFolder()
String	modelPackage()
Map<String,String>	modelTemplateFiles()
protected boolean	needToImport(String type)
String	outputFolder()
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessSwagger(io.swagger.models.Swagger swagger)
void	processOpts()
void	processSwagger(io.swagger.models.Swagger swagger)
String	removeNonNameElementToCamelCase(String name) Remove characters not suitable for variable or method name from the input and camelize it
Set<String>	reservedWords()
String	sanitizeName(String name) sanitize name (parameter, property, method, etc)
void	setApiPackage(String apiPackage)
void	setLibrary(String library)
void	setModelPackage(String modelPackage)
protected void	setNonArrayMapProperty(CodegenProperty property, String type)
void	setOutputDir(String dir)
void	setSkipOverwrite(boolean skipOverwrite)
void	setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)
void	setTemplateDir(String templateDir)
boolean	shouldOverwrite(String filename)
String	snakeCase(String name)
Map<String,String>	supportedLibraries() All library templates supported.
List<SupportingFile>	supportingFiles()
String	templateDir()
String	toApiFilename(String name)
String	toApiImport(String name)
String	toApiName(String name)
String	toApiVarName(String name)
String	toDefaultValue(io.swagger.models.properties.Property p)
String	toEnumName(CodegenProperty property)
protected List<Map<String,Object>>	toExamples(Map<String,Object> examples)
String	toInstantiationType(io.swagger.models.properties.Property p)
String	toModelFilename(String name)
String	toModelImport(String name)
String	toModelName(String name)
String	toOperationId(String operationId)
String	toParamName(String name)
String	toVarName(String name)
Map<String,String>	typeMapping()
static String	underscore(String word) Underscore the given word.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

outputFolder

protected String outputFolder

defaultIncludes

protected Set<String> defaultIncludes

typeMapping

protected Map<String,String> typeMapping

instantiationTypes

protected Map<String,String> instantiationTypes

reservedWords

protected Set<String> reservedWords

languageSpecificPrimitives

protected Set<String> languageSpecificPrimitives

importMapping

protected Map<String,String> importMapping

modelPackage

protected String modelPackage

apiPackage

protected String apiPackage

fileSuffix

protected String fileSuffix

apiTemplateFiles

protected Map<String,String> apiTemplateFiles

modelTemplateFiles

protected Map<String,String> modelTemplateFiles

templateDir

protected String templateDir

additionalProperties

protected Map<String,Object> additionalProperties

supportingFiles

protected List<SupportingFile> supportingFiles

cliOptions

protected List<CliOption> cliOptions

skipOverwrite

protected boolean skipOverwrite

supportsInheritance

protected boolean supportsInheritance

supportedLibraries

protected Map<String,String> supportedLibraries

library

protected String library

sortParamsByRequiredFlag

protected Boolean sortParamsByRequiredFlag

Constructor Detail

DefaultCodegen

public DefaultCodegen()

Method Detail

cliOptions

public List<CliOption> cliOptions()

processOpts

public void processOpts()

postProcessModels

public Map<String,Object> postProcessModels(Map<String,Object> objs)

postProcessOperations

public Map<String,Object> postProcessOperations(Map<String,Object> objs)

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

preprocessSwagger

public void preprocessSwagger(io.swagger.models.Swagger swagger)

processSwagger

public void processSwagger(io.swagger.models.Swagger swagger)

escapeText

public String escapeText(String input)

defaultIncludes

public Set<String> defaultIncludes()

typeMapping

public Map<String,String> typeMapping()

instantiationTypes

public Map<String,String> instantiationTypes()

reservedWords

public Set<String> reservedWords()

languageSpecificPrimitives

public Set<String> languageSpecificPrimitives()

importMapping

public Map<String,String> importMapping()

modelPackage

public String modelPackage()

apiPackage

public String apiPackage()

fileSuffix

public String fileSuffix()

templateDir

public String templateDir()

apiTemplateFiles

public Map<String,String> apiTemplateFiles()

modelTemplateFiles

public Map<String,String> modelTemplateFiles()

apiFileFolder

public String apiFileFolder()

modelFileFolder

public String modelFileFolder()

additionalProperties

public Map<String,Object> additionalProperties()

supportingFiles

public List<SupportingFile> supportingFiles()

outputFolder

public String outputFolder()

setOutputDir

public void setOutputDir(String dir)

getOutputDir

public String getOutputDir()

setTemplateDir

public void setTemplateDir(String templateDir)

setModelPackage

public void setModelPackage(String modelPackage)

setApiPackage

public void setApiPackage(String apiPackage)

setSortParamsByRequiredFlag

public void setSortParamsByRequiredFlag(Boolean sortParamsByRequiredFlag)

toApiFilename

public String toApiFilename(String name)

toApiVarName

public String toApiVarName(String name)

toModelFilename

public String toModelFilename(String name)

toOperationId

public String toOperationId(String operationId)

toVarName

public String toVarName(String name)

toParamName

public String toParamName(String name)

toEnumName

public String toEnumName(CodegenProperty property)

escapeReservedWord

public String escapeReservedWord(String name)

toModelImport

public String toModelImport(String name)

toApiImport

public String toApiImport(String name)

generateExamplePath

public String generateExamplePath(String path,
                         io.swagger.models.Operation operation)

toInstantiationType

public String toInstantiationType(io.swagger.models.properties.Property p)

toDefaultValue

public String toDefaultValue(io.swagger.models.properties.Property p)

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

returns the swagger type for the property

snakeCase

public String snakeCase(String name)

initialCaps

public String initialCaps(String name)

getTypeDeclaration

public String getTypeDeclaration(String name)

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

toApiName

public String toApiName(String name)

toModelName

public String toModelName(String name)

fromModel

public CodegenModel fromModel(String name,
                     io.swagger.models.Model model)

fromModel

public CodegenModel fromModel(String name,
                     io.swagger.models.Model model,
                     Map<String,io.swagger.models.Model> allDefinitions)

getterAndSetterCapitalize

public String getterAndSetterCapitalize(String name)

fromProperty

public CodegenProperty fromProperty(String name,
                           io.swagger.models.properties.Property p)

setNonArrayMapProperty

protected void setNonArrayMapProperty(CodegenProperty property,
                          String type)

fromOperation

public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions)

fromOperation

public CodegenOperation fromOperation(String path,
                             String httpMethod,
                             io.swagger.models.Operation operation,
                             Map<String,io.swagger.models.Model> definitions,
                             io.swagger.models.Swagger swagger)

fromResponse

public CodegenResponse fromResponse(String responseCode,
                           io.swagger.models.Response response)

fromParameter

public CodegenParameter fromParameter(io.swagger.models.parameters.Parameter param,
                             Set<String> imports)

fromSecurity

public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)

needToImport

protected boolean needToImport(String type)

toExamples

protected List<Map<String,Object>> toExamples(Map<String,Object> examples)

addOperationToGroup

public void addOperationToGroup(String tag,
                       String resourcePath,
                       io.swagger.models.Operation operation,
                       CodegenOperation co,
                       Map<String,List<CodegenOperation>> operations)

underscore

public static String underscore(String word)

Underscore the given word.

Parameters:

word - The word

Returns:

The underscored version of the word

removeNonNameElementToCamelCase

public String removeNonNameElementToCamelCase(String name)

Remove characters not suitable for variable or method name from the input and camelize it

Parameters:

name -

Returns:

camelize

public static String camelize(String word)

camelize

public static String camelize(String word,
              boolean lowercaseFirstLetter)

apiFilename

public String apiFilename(String templateName,
                 String tag)

shouldOverwrite

public boolean shouldOverwrite(String filename)

isSkipOverwrite

public boolean isSkipOverwrite()

setSkipOverwrite

public void setSkipOverwrite(boolean skipOverwrite)

supportedLibraries

public Map<String,String> supportedLibraries()

All library templates supported. (key: library name, value: library description)

setLibrary

public void setLibrary(String library)

getLibrary

public String getLibrary()

Library template (sub-template).

buildLibraryCliOption

protected CliOption buildLibraryCliOption(Map<String,String> supportedLibraries)

sanitizeName

public String sanitizeName(String name)

sanitize name (parameter, property, method, etc)

Parameters:

name - string to be sanitize

Returns:

sanitized string