org.openapitools.codegen

Interface CodegenConfig

All Known Implementing Classes:

AbstractAdaCodegen, AbstractApexCodegen, AbstractCppCodegen, AbstractCSharpCodegen, AbstractEiffelCodegen, AbstractFSharpCodegen, AbstractGoCodegen, AbstractGraphQLCodegen, AbstractJavaCodegen, AbstractJavaJAXRSServerCodegen, AbstractKotlinCodegen, AbstractPhpCodegen, AbstractRubyCodegen, AbstractScalaCodegen, AbstractTypeScriptClientCodegen, AdaCodegen, AdaServerCodegen, AndroidClientCodegen, Apache2ConfigCodegen, ApexClientCodegen, AspNetCoreServerCodegen, BashClientCodegen, CLibcurlClientCodegen, ClojureClientCodegen, ConfluenceWikiCodegen, CppPistacheServerCodegen, CppQt5AbstractCodegen, CppQt5ClientCodegen, CppQt5QHttpEngineServerCodegen, CppRestbedServerCodegen, CppRestSdkClientCodegen, CppTizenClientCodegen, CSharpClientCodegen, CSharpDotNet2ClientCodegen, CSharpNancyFXServerCodegen, CSharpNetCoreClientCodegen, DartClientCodegen, DartJaguarClientCodegen, DefaultCodegen, EiffelClientCodegen, ElixirClientCodegen, ElmClientCodegen, ErlangClientCodegen, ErlangProperCodegen, ErlangServerCodegen, FinchServerCodegen, FlashClientCodegen, FsharpGiraffeServerCodegen, GoClientCodegen, GoGinServerCodegen, GoServerCodegen, GraphQLNodeJSExpressServerCodegen, GraphQLSchemaCodegen, GroovyClientCodegen, HaskellHttpClientCodegen, HaskellServantCodegen, JavaClientCodegen, JavaCXFClientCodegen, JavaCXFExtServerCodegen, JavaCXFServerCodegen, JavaInflectorServerCodegen, JavaJAXRSCXFCDIServerCodegen, JavaJAXRSSpecServerCodegen, JavaJerseyServerCodegen, JavaMSF4JServerCodegen, JavaPKMSTServerCodegen, JavaPlayFrameworkCodegen, JavaResteasyEapServerCodegen, JavaResteasyServerCodegen, JavascriptClientCodegen, JavascriptClosureAngularClientCodegen, JavascriptFlowtypedClientCodegen, JavaUndertowServerCodegen, JavaVertXServerCodegen, JMeterClientCodegen, KotlinClientCodegen, KotlinServerCodegen, KotlinSpringServerCodegen, LuaClientCodegen, MysqlSchemaCodegen, NodeJSServerCodegen, ObjcClientCodegen, OpenAPIGenerator, OpenAPIYamlGenerator, PerlClientCodegen, PhpClientCodegen, PhpLaravelServerCodegen, PhpLumenServerCodegen, PhpSilexServerCodegen, PhpSlimServerCodegen, PhpSymfonyServerCodegen, PhpZendExpressivePathHandlerServerCodegen, PowerShellClientCodegen, PythonAbstractConnexionServerCodegen, PythonAiohttpConnexionServerCodegen, PythonBluePlanetServerCodegen, PythonClientCodegen, PythonFlaskConnexionServerCodegen, RClientCodegen, RubyClientCodegen, RubyOnRailsServerCodegen, RubySinatraServerCodegen, RustClientCodegen, RustServerCodegen, ScalaAkkaClientCodegen, ScalaGatlingCodegen, ScalaHttpClientCodegen, ScalaLagomServerCodegen, ScalaPlayFrameworkServerCodegen, ScalatraServerCodegen, ScalazClientCodegen, SpringCodegen, StaticDocCodegen, StaticHtml2Generator, StaticHtmlGenerator, Swift3Codegen, Swift4Codegen, SwiftClientCodegen, TypeScriptAngularClientCodegen, TypeScriptAngularJsClientCodegen, TypeScriptAureliaClientCodegen, TypeScriptAxiosClientCodegen, TypeScriptFetchClientCodegen, TypeScriptInversifyClientCodegen, TypeScriptJqueryClientCodegen, TypeScriptNodeClientCodegen, TypeScriptRxjsClientCodegen

public interface CodegenConfig

Method Summary

Modifier and Type	Method and Description
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()
List<CliOption>	cliOptions()
Set<String>	defaultIncludes()
String	embeddedTemplateDir()
String	encodePath(String text)
String	escapeQuotationMark(String input)
String	escapeReservedWord(String name)
String	escapeText(String text)
String	escapeTextWhileAllowingNewLines(String text)
String	escapeUnsafeCharacters(String input)
String	fileSuffix()
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema)
CodegenOperation	fromOperation(String resourcePath, String httpMethod, io.swagger.v3.oas.models.Operation operation, List<io.swagger.v3.oas.models.servers.Server> servers)
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemas)
List<CodegenServer>	fromServers(List<io.swagger.v3.oas.models.servers.Server> servers)
List<CodegenServerVariable>	fromServerVariables(Map<String,io.swagger.v3.oas.models.servers.ServerVariable> variables)
String	generateExamplePath(String path, io.swagger.v3.oas.models.Operation operation)
String	getCommonTemplateDir()
String	getDocExtension()
GeneratorMetadata	getGeneratorMetadata()
String	getGitRepoId()
String	getGitUserId()
String	getHelp()
String	getHttpUserAgent()
String	getIgnoreFilePathOverride()
String	getInputSpec()
String	getLibrary() Library template (sub-template).
String	getName()
String	getOutputDir()
String	getReleaseNote()
CodegenType	getTag()
TemplatingEngineAdapter	getTemplatingEngine()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)
String	getTypeDeclaration(String name)
Map<String,String>	importMapping()
Map<String,String>	instantiationTypes()
boolean	isEnableMinimalUpdate()
boolean	isEnablePostProcessFile()
boolean	isHideGenerationTimestamp()
boolean	isRemoveOperationIdPrefix()
boolean	isSkipOverwrite()
boolean	isStrictSpecBehavior()
Set<String>	languageSpecificPrimitives()
String	modelDocFileFolder()
Map<String,String>	modelDocTemplateFiles()
String	modelFileFolder()
String	modelPackage()
Map<String,String>	modelTemplateFiles()
String	modelTestFileFolder()
Map<String,String>	modelTestTemplateFiles()
String	outputFolder()
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessFile(File file, String fileType)
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessModels(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()
TemplatingEngineAdapter	processTemplatingEngine(TemplatingEngineAdapter templatingEngine)
Set<String>	reservedWords()
Map<String,String>	reservedWordsMappings()
String	sanitizeName(String name)
String	sanitizeTag(String tag)
void	setDocExtension(String docExtension)
void	setEnableMinimalUpdate(boolean isEnableMinimalUpdate)
void	setEnablePostProcessFile(boolean isEnablePostProcessFile)
void	setGitRepoId(String gitRepoId)
void	setGitUserId(String gitUserId)
void	setHideGenerationTimestamp(boolean hideGenerationTimestamp)
void	setHttpUserAgent(String httpUserAgent)
void	setIgnoreFilePathOverride(String ignoreFileOverride)
void	setInputSpec(String inputSpec)
void	setLibrary(String library)
void	setOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI) Set the OpenAPI instance.
void	setOutputDir(String dir)
void	setReleaseNote(String releaseNote)
void	setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
void	setSkipOverwrite(boolean skipOverwrite)
void	setStrictSpecBehavior(boolean strictSpecBehavior)
void	setTemplatingEngine(TemplatingEngineAdapter s)
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>	updateAllModels(Map<String,Object> objs)
Map<String,Object>	vendorExtensions()

Method Detail

getGeneratorMetadata

GeneratorMetadata getGeneratorMetadata()

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()

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)

escapeTextWhileAllowingNewLines

String escapeTextWhileAllowingNewLines(String text)

encodePath

String encodePath(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()

getInputSpec

String getInputSpec()

setInputSpec

void setInputSpec(String inputSpec)

getOutputDir

String getOutputDir()

setOutputDir

void setOutputDir(String dir)

fromModel

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

fromOperation

CodegenOperation fromOperation(String resourcePath,
                               String httpMethod,
                               io.swagger.v3.oas.models.Operation operation,
                               List<io.swagger.v3.oas.models.servers.Server> servers)

fromSecurity

List<CodegenSecurity> fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemas)

fromServers

List<CodegenServer> fromServers(List<io.swagger.v3.oas.models.servers.Server> servers)

fromServerVariables

List<CodegenServerVariable> fromServerVariables(Map<String,io.swagger.v3.oas.models.servers.ServerVariable> variables)

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)

processTemplatingEngine

TemplatingEngineAdapter processTemplatingEngine(TemplatingEngineAdapter templatingEngine)

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)

updateAllModels

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

postProcessAllModels

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

postProcessModels

Map<String,Object> postProcessModels(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)

isHideGenerationTimestamp

boolean isHideGenerationTimestamp()

setHideGenerationTimestamp

void setHideGenerationTimestamp(boolean hideGenerationTimestamp)

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()

setReleaseNote

void setReleaseNote(String releaseNote)

getReleaseNote

String getReleaseNote()

setHttpUserAgent

void setHttpUserAgent(String httpUserAgent)

getHttpUserAgent

String getHttpUserAgent()

setDocExtension

void setDocExtension(String docExtension)

getDocExtension

String getDocExtension()

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)

sanitizeName

String sanitizeName(String name)

postProcessFile

void postProcessFile(File file,
                     String fileType)

isEnablePostProcessFile

boolean isEnablePostProcessFile()

setEnablePostProcessFile

void setEnablePostProcessFile(boolean isEnablePostProcessFile)

setOpenAPI

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

Set the OpenAPI instance. This method needs to be called right after the instantiation of the Codegen class.

Parameters:

openAPI - specification being generated

setTemplatingEngine

void setTemplatingEngine(TemplatingEngineAdapter s)

getTemplatingEngine

TemplatingEngineAdapter getTemplatingEngine()

isEnableMinimalUpdate

boolean isEnableMinimalUpdate()

setEnableMinimalUpdate

void setEnableMinimalUpdate(boolean isEnableMinimalUpdate)

isStrictSpecBehavior

boolean isStrictSpecBehavior()

setStrictSpecBehavior

void setStrictSpecBehavior(boolean strictSpecBehavior)