Interface CodegenConfig

    • Method Detail

      • getFilesMetadataFilename

        String getFilesMetadataFilename()
      • getVersionMetadataFilename

        String getVersionMetadataFilename()
      • 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()
      • escapeTextWhileAllowingNewLines

        String escapeTextWhileAllowingNewLines​(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()
      • generateExamplePath

        String generateExamplePath​(String path,
                                   io.swagger.v3.oas.models.Operation operation)
      • 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)
      • fromServers

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

        Set<String> defaultIncludes()
      • languageSpecificPrimitives

        Set<String> languageSpecificPrimitives()
      • 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)
      • toApiTestFilename

        String toApiTestFilename​(String name)
      • toModelTestFilename

        String toModelTestFilename​(String name)
      • toApiDocFilename

        String toApiDocFilename​(String name)
      • toModelDocFilename

        String toModelDocFilename​(String name)
      • postProcess

        void postProcess()
      • 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()
      • 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
      • isEnableMinimalUpdate

        boolean isEnableMinimalUpdate()
      • setEnableMinimalUpdate

        void setEnableMinimalUpdate​(boolean isEnableMinimalUpdate)
      • isStrictSpecBehavior

        boolean isStrictSpecBehavior()
      • setStrictSpecBehavior

        void setStrictSpecBehavior​(boolean strictSpecBehavior)
      • 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()
      • generatorLanguageVersion

        String generatorLanguageVersion()
      • getUseInlineModelResolver

        boolean getUseInlineModelResolver()
      • getAddSuffixToDuplicateOperationNicknames

        boolean getAddSuffixToDuplicateOperationNicknames()
      • getUseOpenAPINormalizer

        boolean getUseOpenAPINormalizer()