Package io.swagger.codegen.v3

Interface CodegenConfig

public interface CodegenConfig

  • Method Details

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