Package org.openapitools.codegen
Interface CodegenConfig
-
- All Known Implementing Classes:
AbstractAdaCodegen
,AbstractApexCodegen
,AbstractCppCodegen
,AbstractCSharpCodegen
,AbstractDartCodegen
,AbstractEiffelCodegen
,AbstractFSharpCodegen
,AbstractGoCodegen
,AbstractGraphQLCodegen
,AbstractJavaCodegen
,AbstractJavaJAXRSServerCodegen
,AbstractJuliaCodegen
,AbstractKotlinCodegen
,AbstractPhpCodegen
,AbstractPythonCodegen
,AbstractPythonConnexionServerCodegen
,AbstractPythonPydanticV1Codegen
,AbstractRubyCodegen
,AbstractRustCodegen
,AbstractScalaCodegen
,AbstractTypeScriptClientCodegen
,AdaCodegen
,AdaServerCodegen
,AndroidClientCodegen
,Apache2ConfigCodegen
,ApexClientCodegen
,AsciidocDocumentationCodegen
,AspNetServerCodegen
,AvroSchemaCodegen
,BashClientCodegen
,CLibcurlClientCodegen
,ClojureClientCodegen
,ConfluenceWikiCodegen
,CppPistacheServerCodegen
,CppQtAbstractCodegen
,CppQtClientCodegen
,CppQtQHttpEngineServerCodegen
,CppRestbedServerCodegen
,CppRestbedServerDeprecatedCodegen
,CppRestSdkClientCodegen
,CppTinyClientCodegen
,CppTizenClientCodegen
,CppUE4ClientCodegen
,CrystalClientCodegen
,CSharpClientCodegen
,CSharpFunctionsServerCodegen
,CSharpReducedClientCodegen
,DartClientCodegen
,DartDioClientCodegen
,DefaultCodegen
,EiffelClientCodegen
,ElixirClientCodegen
,ElmClientCodegen
,ErlangClientCodegen
,ErlangProperCodegen
,ErlangServerCodegen
,FsharpFunctionsServerCodegen
,FsharpGiraffeServerCodegen
,GoClientCodegen
,GoEchoServerCodegen
,GoGinServerCodegen
,GoServerCodegen
,GraphQLNodeJSExpressServerCodegen
,GraphQLSchemaCodegen
,GroovyClientCodegen
,HaskellHttpClientCodegen
,HaskellServantCodegen
,HaskellYesodServerCodegen
,JavaCamelServerCodegen
,JavaClientCodegen
,JavaCXFClientCodegen
,JavaCXFExtServerCodegen
,JavaCXFServerCodegen
,JavaHelidonClientCodegen
,JavaHelidonCommonCodegen
,JavaHelidonServerCodegen
,JavaInflectorServerCodegen
,JavaJAXRSCXFCDIServerCodegen
,JavaJAXRSSpecServerCodegen
,JavaJerseyServerCodegen
,JavaMicronautAbstractCodegen
,JavaMicronautClientCodegen
,JavaMicronautServerCodegen
,JavaMSF4JServerCodegen
,JavaPKMSTServerCodegen
,JavaPlayFrameworkCodegen
,JavaResteasyEapServerCodegen
,JavaResteasyServerCodegen
,JavascriptApolloClientCodegen
,JavascriptClientCodegen
,JavascriptClosureAngularClientCodegen
,JavascriptFlowtypedClientCodegen
,JavaUndertowServerCodegen
,JavaVertXServerCodegen
,JavaVertXWebServerCodegen
,JavaWiremockServerCodegen
,JetbrainsHttpClientClientCodegen
,JMeterClientCodegen
,JuliaClientCodegen
,JuliaServerCodegen
,K6ClientCodegen
,KotlinClientCodegen
,KotlinServerCodegen
,KotlinSpringServerCodegen
,KotlinVertxServerCodegen
,KtormSchemaCodegen
,LuaClientCodegen
,MarkdownDocumentationCodegen
,MysqlSchemaCodegen
,N4jsClientCodegen
,NimClientCodegen
,NodeJSExpressServerCodegen
,ObjcClientCodegen
,OCamlClientCodegen
,OpenAPIGenerator
,OpenAPIYamlGenerator
,PerlClientCodegen
,PhpClientCodegen
,PhpDataTransferClientCodegen
,PhpLaravelServerCodegen
,PhpLumenServerCodegen
,PhpMezzioPathHandlerServerCodegen
,PhpNextgenClientCodegen
,PhpSilexServerCodegen
,PhpSlim4ServerCodegen
,PhpSymfonyServerCodegen
,PlantumlDocumentationCodegen
,PostmanCollectionCodegen
,PowerShellClientCodegen
,ProtobufSchemaCodegen
,PythonAiohttpConnexionServerCodegen
,PythonBluePlanetServerCodegen
,PythonClientCodegen
,PythonFastAPIServerCodegen
,PythonFlaskConnexionServerCodegen
,PythonPydanticV1ClientCodegen
,RClientCodegen
,RubyClientCodegen
,RubyOnRailsServerCodegen
,RubySinatraServerCodegen
,RustAxumServerCodegen
,RustClientCodegen
,RustServerCodegen
,ScalaAkkaClientCodegen
,ScalaAkkaHttpServerCodegen
,ScalaCaskServerCodegen
,ScalaFinchServerCodegen
,ScalaGatlingCodegen
,ScalaHttp4sServerCodegen
,ScalaLagomServerCodegen
,ScalaPekkoClientCodegen
,ScalaPlayFrameworkServerCodegen
,ScalaSttp4ClientCodegen
,ScalaSttpClientCodegen
,ScalatraServerCodegen
,ScalazClientCodegen
,SpringCodegen
,StaticDocCodegen
,StaticHtml2Generator
,StaticHtmlGenerator
,Swift5ClientCodegen
,SwiftCombineClientCodegen
,TypeScriptAngularClientCodegen
,TypeScriptAureliaClientCodegen
,TypeScriptAxiosClientCodegen
,TypeScriptClientCodegen
,TypeScriptFetchClientCodegen
,TypeScriptInversifyClientCodegen
,TypeScriptJqueryClientCodegen
,TypeScriptNestjsClientCodegen
,TypeScriptNodeClientCodegen
,TypeScriptReduxQueryClientCodegen
,TypeScriptRxjsClientCodegen
,WsdlSchemaCodegen
,XojoClientCodegen
,ZapierClientCodegen
public interface CodegenConfig
-
-
Method Summary
-
-
-
Method Detail
-
getFilesMetadataFilename
String getFilesMetadataFilename()
-
getVersionMetadataFilename
String getVersionMetadataFilename()
-
getGeneratorMetadata
GeneratorMetadata getGeneratorMetadata()
-
getTag
CodegenType getTag()
-
getName
String getName()
-
getHelp
String getHelp()
-
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()
-
getTypeDeclaration
String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)
-
processOpts
void processOpts()
-
generateExamplePath
String generateExamplePath(String path, io.swagger.v3.oas.models.Operation operation)
-
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)
-
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)
-
addOperationToGroup
void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, CodegenOperation co, Map<String,List<CodegenOperation>> operations)
-
postProcess
void postProcess()
-
postProcessOperationsWithModels
OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
-
postProcessWebhooksWithModels
WebhooksMap postProcessWebhooksWithModels(WebhooksMap objs, List<ModelMap> allModels)
-
postProcessSupportingFileData
Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
-
postProcessModelProperty
void postProcessModelProperty(CodegenModel model, CodegenProperty property)
-
postProcessResponseWithProperty
void postProcessResponseWithProperty(CodegenResponse response, CodegenProperty property)
-
postProcessParameter
void postProcessParameter(CodegenParameter parameter)
-
shouldOverwrite
boolean shouldOverwrite(String filename)
-
isSkipOverwrite
boolean isSkipOverwrite()
-
setSkipOverwrite
void setSkipOverwrite(boolean skipOverwrite)
-
isRemoveOperationIdPrefix
boolean isRemoveOperationIdPrefix()
-
setRemoveOperationIdPrefix
void setRemoveOperationIdPrefix(boolean removeOperationIdPrefix)
-
isSkipOperationExample
boolean isSkipOperationExample()
-
setSkipOperationExample
void setSkipOperationExample(boolean skipOperationExample)
-
isHideGenerationTimestamp
boolean isHideGenerationTimestamp()
-
setHideGenerationTimestamp
void setHideGenerationTimestamp(boolean hideGenerationTimestamp)
-
setLibrary
void setLibrary(String library)
-
getLibrary
String getLibrary()
Library template (sub-template).- Returns:
- library template
-
setGitHost
void setGitHost(String gitHost)
-
getGitHost
String getGitHost()
-
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()
-
setIgnoreFilePathOverride
void setIgnoreFilePathOverride(String ignoreFileOverride)
-
getIgnoreFilePathOverride
String getIgnoreFilePathOverride()
-
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)
-
getFeatureSet
FeatureSet getFeatureSet()
-
isRemoveEnumValuePrefix
boolean isRemoveEnumValuePrefix()
-
setRemoveEnumValuePrefix
void setRemoveEnumValuePrefix(boolean removeEnumValuePrefix)
-
unaliasSchema
io.swagger.v3.oas.models.media.Schema unaliasSchema(io.swagger.v3.oas.models.media.Schema schema)
-
defaultTemplatingEngine
String defaultTemplatingEngine()
-
generatorLanguage
GeneratorLanguage generatorLanguage()
-
generatorLanguageVersion
String generatorLanguageVersion()
-
isTypeErasedGenerics
boolean isTypeErasedGenerics()
-
getSupportedVendorExtensions
List<VendorExtension> getSupportedVendorExtensions()
-
getUseInlineModelResolver
boolean getUseInlineModelResolver()
-
getAddSuffixToDuplicateOperationNicknames
boolean getAddSuffixToDuplicateOperationNicknames()
-
getUseOpenapiNormalizer
boolean getUseOpenapiNormalizer()
-
-