Package io.swagger.codegen.v3.generators.html

Class StaticHtmlCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.html.StaticHtmlCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class StaticHtmlCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	artifactId
protected String	artifactVersion
static String	DOCUMENT_NO_OBJECTS
protected String	groupId
protected String	invokerPackage

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, LOGGER, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
StaticHtmlCodegen()

Method Summary

Modifier and Type	Method	Description
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
String	escapeText(String input)	Convert Markdown (CommonMark) to HTML.
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
String	getArgumentsLocation()
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.ISchemaHandler	getSchemaHandler()
io.swagger.codegen.v3.CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema propertySchema)	Output the type declaration of the property
void	postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
void	postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
String	toHtml(String input)	Convert Markdown text to HTML
String	toModelName(String name)	Output the proper model name (capitalized).

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeReservedWord, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaType, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessSupportingFileData, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toVarName, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

checkAliasModel, getCodeName, getPriority, isPrivileged

Field Detail

DOCUMENT_NO_OBJECTS

public static final String DOCUMENT_NO_OBJECTS

See Also:

Constant Field Values

invokerPackage

protected String invokerPackage

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

Constructor Detail

StaticHtmlCodegen

public StaticHtmlCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class DefaultCodegenConfig

escapeText

public String escapeText(String input)

Convert Markdown (CommonMark) to HTML. This class also disables normal HTML escaping in the Mustache engine (see processCompiler(Compiler) above.)

Specified by:

escapeText in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeText in class DefaultCodegenConfig

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getArgumentsLocation

public String getArgumentsLocation()

Overrides:

getArgumentsLocation in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

getName

public String getName()

getHelp

public String getHelp()

getTypeDeclaration

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

Description copied from class: DefaultCodegenConfig

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegenConfig

Parameters:

propertySchema - Schema Property object

Returns:

a string presentation of the property type

postProcessOperations

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

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegenConfig

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegenConfig

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegenConfig

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped

toHtml

public String toHtml(String input)

Convert Markdown text to HTML

Parameters:

input - text in Markdown; may be null.

Returns:

the text, converted to Markdown. For null input, "" is returned.

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegenConfig

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelName in class DefaultCodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

preprocessOpenAPI

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

Specified by:

preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

preprocessOpenAPI in class DefaultCodegenConfig

postProcessParameter

public void postProcessParameter(io.swagger.codegen.v3.CodegenParameter parameter)

Specified by:

postProcessParameter in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegenConfig

postProcessModelProperty

public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model,
                                     io.swagger.codegen.v3.CodegenProperty property)

Specified by:

postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModelProperty in class DefaultCodegenConfig

getSchemaHandler

public io.swagger.codegen.v3.ISchemaHandler getSchemaHandler()

Specified by:

getSchemaHandler in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getSchemaHandler in class DefaultCodegenConfig