io.swagger.codegen

Interface CodegenConfig

All Known Implementing Classes:

AkkaScalaClientCodegen, AndroidClientCodegen, AsyncScalaClientCodegen, CSharpClientCodegen, JavaClientCodegen, JaxRSServerCodegen, NodeJSServerCodegen, ObjcClientCodegen, PerlClientCodegen, PhpClientCodegen, Python3ClientCodegen, PythonClientCodegen, Qt5CPPGenerator, RetrofitClientCodegen, RubyClientCodegen, ScalaClientCodegen, ScalatraServerCodegen, SpringMVCServerCodegen, StaticDocCodegen, StaticHtmlGenerator, SwaggerGenerator, SwaggerYamlGenerator, SwiftGenerator, TizenClientCodegen

public interface CodegenConfig

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()
List<CliOption>	cliOptions()
Set<String>	defaultIncludes()
String	escapeReservedWord(String name)
String	escapeText(String text)
String	fileSuffix()
CodegenModel	fromModel(String name, io.swagger.models.Model model)
CodegenOperation	fromOperation(String resourcePath, String httpMethod, io.swagger.models.Operation operation, Map<String,io.swagger.models.Model> definitions)
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.models.auth.SecuritySchemeDefinition> schemes)
String	generateExamplePath(String path, io.swagger.models.Operation operation)
String	getHelp()
String	getName()
String	getOutputDir()
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p)
String	getTypeDeclaration(String name)
Map<String,String>	importMapping()
Map<String,String>	instantiationTypes()
String	modelFileFolder()
String	modelPackage()
Map<String,String>	modelTemplateFiles()
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	processOpts()
void	processSwagger(io.swagger.models.Swagger swagger)
Set<String>	reservedWords()
void	setOutputDir(String dir)
boolean	shouldOverwrite(String filename)
List<SupportingFile>	supportingFiles()
String	templateDir()
String	toApiFilename(String name)
String	toApiImport(String name)
String	toApiName(String name)
String	toApiVarName(String name)
String	toModelFilename(String name)
String	toModelImport(String name)
String	toModelName(String name)
String	toParamName(String name)
Map<String,String>	typeMapping()

Method Detail

getTag

CodegenType getTag()

getName

String getName()

getHelp

String getHelp()

additionalProperties

Map<String,Object> additionalProperties()

apiPackage

String apiPackage()

apiFileFolder

String apiFileFolder()

fileSuffix

String fileSuffix()

outputFolder

String outputFolder()

templateDir

String templateDir()

modelFileFolder

String modelFileFolder()

modelPackage

String modelPackage()

toApiName

String toApiName(String name)

toApiVarName

String toApiVarName(String name)

toModelName

String toModelName(String name)

toParamName

String toParamName(String name)

escapeText

String escapeText(String text)

escapeReservedWord

String escapeReservedWord(String name)

getTypeDeclaration

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

getTypeDeclaration

String getTypeDeclaration(String name)

processOpts

void processOpts()

cliOptions

List<CliOption> cliOptions()

generateExamplePath

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

reservedWords

Set<String> reservedWords()

supportingFiles

List<SupportingFile> supportingFiles()

getOutputDir

String getOutputDir()

setOutputDir

void setOutputDir(String dir)

fromModel

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

fromOperation

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

fromSecurity

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

defaultIncludes

Set<String> defaultIncludes()

typeMapping

Map<String,String> typeMapping()

instantiationTypes

Map<String,String> instantiationTypes()

importMapping

Map<String,String> importMapping()

apiTemplateFiles

Map<String,String> apiTemplateFiles()

modelTemplateFiles

Map<String,String> modelTemplateFiles()

processSwagger

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

toApiFilename

String toApiFilename(String name)

toModelFilename

String toModelFilename(String name)

toModelImport

String toModelImport(String name)

toApiImport

String toApiImport(String name)

addOperationToGroup

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

postProcessModels

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

postProcessOperations

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

postProcessSupportingFileData

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

apiFilename

String apiFilename(String templateName,
                 String tag)

shouldOverwrite

boolean shouldOverwrite(String filename)