Package io.swagger.codegen.v3

Interface CodegenConfig

public interface CodegenConfig

Method Summary

Modifier and Type	Method	Description
void	addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)
Map<String,Object>	additionalProperties()
void	addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
String	apiDocFileFolder()
String	apiDocFilename(String templateName, String tag)
Map<String,String>	apiDocTemplateFiles()
String	apiFileFolder()
String	apiFilename(String templateName, String tag)
String	apiPackage()
Map<String,String>	apiTemplateFiles()
String	apiTestFileFolder()
String	apiTestFilename(String templateName, String tag)
Map<String,String>	apiTestTemplateFiles()
default boolean	checkAliasModel()
List<CliOption>	cliOptions()
List<SupportingFile>	configFiles()
String	customTemplateDir()
boolean	defaultIgnoreImportMappingOption()
Set<String>	defaultIncludes()
String	embeddedTemplateDir()
String	escapeQuotationMark(String input)
String	escapeReservedWord(String name)
String	escapeText(String text)
String	escapeUnsafeCharacters(String input)
String	fileSuffix()
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema)
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)
CodegenOperation	fromOperation(String resourcePath, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions)
CodegenOperation	fromOperation(String resourcePath, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions, io.swagger.v3.oas.models.OpenAPI openAPI)
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemes)
String	generateExamplePath(String path, io.swagger.v3.oas.models.Operation operation)
default String	getCodeName()
String	getCommonTemplateDir()
String	getGitRepoBaseURL()
String	getGitRepoId()
String	getGitUserId()
String	getHelp()
String	getHttpUserAgent()
String	getIgnoreFilePathOverride()
boolean	getIgnoreImportMapping()
String	getInputSpec()
String	getInputURL()
List<CodegenArgument>	getLanguageArguments()
String	getLibrary()	Library template (sub-template).
String	getName()
String	getOutputDir()
default int	getPriority()
String	getReleaseNote()
ISchemaHandler	getSchemaHandler()
CodegenType	getTag()
TemplateEngine	getTemplateEngine()
String	getTemplateVersion()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)
String	getTypeDeclaration(String name)
Map<String,String>	importMapping()
Map<String,String>	instantiationTypes()
default boolean	isPrivileged()
boolean	isRemoveOperationIdPrefix()
boolean	isSkipOverwrite()
Set<String>	languageSpecificPrimitives()
String	modelDocFileFolder()
Map<String,String>	modelDocTemplateFiles()
String	modelFileFolder()
String	modelPackage()
Map<String,String>	modelTemplateFiles()
String	modelTestFileFolder()
Map<String,String>	modelTestTemplateFiles()
boolean	needsUnflattenedSpec()
String	outputFolder()
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(CodegenParameter parameter)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
com.samskivert.mustache.Mustache.Compiler	processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)
void	processOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
List<CodegenArgument>	readLanguageArguments()
Set<String>	reservedWords()
Map<String,String>	reservedWordsMappings()
String	sanitizeName(String name)
String	sanitizeTag(String tag)
void	setGitRepoBaseURL(String gitRepoBaseURL)
void	setGitRepoId(String gitRepoId)
void	setGitUserId(String gitUserId)
void	setHttpUserAgent(String httpUserAgent)
void	setIgnoreFilePathOverride(String ignoreFileOverride)
void	setIgnoreImportMapping(boolean ignoreImportMapping)
void	setInputSpec(String inputSpec)
void	setInputURL(String inputSpec)
void	setLanguageArguments(List<CodegenArgument> codegenArguments)
void	setLibrary(String library)
void	setOutputDir(String dir)
void	setReleaseNote(String releaseNote)
void	setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
void	setSkipOverwrite(boolean skipOverwrite)
void	setUnflattenedOpenAPI(io.swagger.v3.oas.models.OpenAPI unflattenedOpenAPI)
boolean	shouldOverwrite(String filename)
Map<String,String>	supportedLibraries()
List<SupportingFile>	supportingFiles()
String	templateDir()
String	testPackage()
String	toApiDocFilename(String name)
String	toApiFilename(String name)
String	toApiImport(String name)
String	toApiName(String name)
String	toApiTestFilename(String name)
String	toApiVarName(String name)
String	toBooleanGetter(String name)
String	toGetter(String name)
String	toModelDocFilename(String name)
String	toModelFilename(String name)
String	toModelImport(String name)
String	toModelName(String name)
String	toModelTestFilename(String name)
String	toParamName(String name)
String	toSetter(String name)
Map<String,String>	typeMapping()
Map<String,Object>	vendorExtensions()

Method Detail

getTag

CodegenType getTag()

getName

String getName()

getHelp

String getHelp()

additionalProperties

Map<String,Object> additionalProperties()

vendorExtensions

Map<String,Object> vendorExtensions()

testPackage

String testPackage()

apiPackage

String apiPackage()

apiFileFolder

String apiFileFolder()

apiTestFileFolder

String apiTestFileFolder()

apiDocFileFolder

String apiDocFileFolder()

fileSuffix

String fileSuffix()

outputFolder

String outputFolder()

templateDir

String templateDir()

embeddedTemplateDir

String embeddedTemplateDir()

customTemplateDir

String customTemplateDir()

getTemplateVersion

String getTemplateVersion()

modelFileFolder

String modelFileFolder()

modelTestFileFolder

String modelTestFileFolder()

modelDocFileFolder

String modelDocFileFolder()

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)

escapeUnsafeCharacters

String escapeUnsafeCharacters(String input)

escapeReservedWord

String escapeReservedWord(String name)

escapeQuotationMark

String escapeQuotationMark(String input)

getTypeDeclaration

String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)

getTypeDeclaration

String getTypeDeclaration(String name)

processOpts

void processOpts()

cliOptions

List<CliOption> cliOptions()

generateExamplePath

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

reservedWords

Set<String> reservedWords()

supportingFiles

List<SupportingFile> supportingFiles()

configFiles

List<SupportingFile> configFiles()

getInputSpec

String getInputSpec()

setInputSpec

void setInputSpec(String inputSpec)

getInputURL

String getInputURL()

setInputURL

void setInputURL(String inputSpec)

getOutputDir

String getOutputDir()

setOutputDir

void setOutputDir(String dir)

fromModel

CodegenModel fromModel(String name,
                       io.swagger.v3.oas.models.media.Schema schema)

fromModel

CodegenModel fromModel(String name,
                       io.swagger.v3.oas.models.media.Schema schema,
                       Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

fromOperation

CodegenOperation fromOperation(String resourcePath,
                               String httpMethod,
                               io.swagger.v3.oas.models.Operation operation,
                               Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
                               io.swagger.v3.oas.models.OpenAPI openAPI)

fromOperation

CodegenOperation fromOperation(String resourcePath,
                               String httpMethod,
                               io.swagger.v3.oas.models.Operation operation,
                               Map<String,io.swagger.v3.oas.models.media.Schema> definitions)

fromSecurity

List<CodegenSecurity> fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> 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()

apiTestTemplateFiles

Map<String,String> apiTestTemplateFiles()

modelTestTemplateFiles

Map<String,String> modelTestTemplateFiles()

apiDocTemplateFiles

Map<String,String> apiDocTemplateFiles()

modelDocTemplateFiles

Map<String,String> modelDocTemplateFiles()

languageSpecificPrimitives

Set<String> languageSpecificPrimitives()

reservedWordsMappings

Map<String,String> reservedWordsMappings()

preprocessOpenAPI

void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

processOpenAPI

void processOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)

processCompiler

com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)

getTemplateEngine

TemplateEngine getTemplateEngine()

sanitizeName

String sanitizeName(String name)

sanitizeTag

String sanitizeTag(String tag)

toApiFilename

String toApiFilename(String name)

toModelFilename

String toModelFilename(String name)

toApiTestFilename

String toApiTestFilename(String name)

toModelTestFilename

String toModelTestFilename(String name)

toApiDocFilename

String toApiDocFilename(String name)

toModelDocFilename

String toModelDocFilename(String name)

toModelImport

String toModelImport(String name)

toApiImport

String toApiImport(String name)

addOperationToGroup

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

postProcessAllModels

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

postProcessModels

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

postProcessOperations

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

postProcessOperationsWithModels

Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                         List<Object> allModels)

postProcessSupportingFileData

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

postProcessModelProperty

void postProcessModelProperty(CodegenModel model,
                              CodegenProperty property)

postProcessParameter

void postProcessParameter(CodegenParameter parameter)

apiFilename

String apiFilename(String templateName,
                   String tag)

apiTestFilename

String apiTestFilename(String templateName,
                       String tag)

apiDocFilename

String apiDocFilename(String templateName,
                      String tag)

shouldOverwrite

boolean shouldOverwrite(String filename)

isSkipOverwrite

boolean isSkipOverwrite()

setSkipOverwrite

void setSkipOverwrite(boolean skipOverwrite)

isRemoveOperationIdPrefix

boolean isRemoveOperationIdPrefix()

setRemoveOperationIdPrefix

void setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)

supportedLibraries

Map<String,String> supportedLibraries()

setLibrary

void setLibrary(String library)

getLibrary

String getLibrary()

Library template (sub-template).

Returns:

libray template

setGitUserId

void setGitUserId(String gitUserId)

getGitUserId

String getGitUserId()

setGitRepoId

void setGitRepoId(String gitRepoId)

getGitRepoId

String getGitRepoId()

setGitRepoBaseURL

void setGitRepoBaseURL(String gitRepoBaseURL)

getGitRepoBaseURL

String getGitRepoBaseURL()

setReleaseNote

void setReleaseNote(String releaseNote)

getReleaseNote

String getReleaseNote()

setHttpUserAgent

void setHttpUserAgent(String httpUserAgent)

getHttpUserAgent

String getHttpUserAgent()

getCommonTemplateDir

String getCommonTemplateDir()

setIgnoreFilePathOverride

void setIgnoreFilePathOverride(String ignoreFileOverride)

getIgnoreFilePathOverride

String getIgnoreFilePathOverride()

toBooleanGetter

String toBooleanGetter(String name)

toSetter

String toSetter(String name)

toGetter

String toGetter(String name)

addHandlebarHelpers

void addHandlebarHelpers(com.github.jknack.handlebars.Handlebars handlebars)

readLanguageArguments

List<CodegenArgument> readLanguageArguments()

getLanguageArguments

List<CodegenArgument> getLanguageArguments()

setLanguageArguments

void setLanguageArguments(List<CodegenArgument> codegenArguments)

needsUnflattenedSpec

boolean needsUnflattenedSpec()

setUnflattenedOpenAPI

void setUnflattenedOpenAPI(io.swagger.v3.oas.models.OpenAPI unflattenedOpenAPI)

getIgnoreImportMapping

boolean getIgnoreImportMapping()

setIgnoreImportMapping

void setIgnoreImportMapping(boolean ignoreImportMapping)

defaultIgnoreImportMappingOption

boolean defaultIgnoreImportMappingOption()

getSchemaHandler

ISchemaHandler getSchemaHandler()

checkAliasModel

default boolean checkAliasModel()

isPrivileged

default boolean isPrivileged()

getPriority

default int getPriority()

getCodeName

default String getCodeName()