org.openapitools.codegen.languages

类 StaticHtmlGenerator

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.StaticHtmlGenerator

所有已实现的接口:

CodegenConfig

public class StaticHtmlGenerator
extends DefaultCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	artifactId
protected String	artifactVersion
protected String	groupId
protected String	invokerPackage

从类继承的字段 org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

构造器概要

构造器

构造器和说明
StaticHtmlGenerator()

方法概要

限定符和类型	方法和说明
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	getHelp()
String	getName()
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
void	postProcessModelProperty(CodegenModel model, CodegenProperty property)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	postProcessParameter(CodegenParameter parameter)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
com.samskivert.mustache.Mustache.Compiler	processCompiler(com.samskivert.mustache.Mustache.Compiler compiler) Markdown conversion emits HTML and by default, the Mustache Mustache.Compiler will escape HTML.
String	toHtml(String input) Convert Markdown text to HTML
String	toModelName(String name) Output the proper model name (capitalized).

从类继承的方法 org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeReservedWord, escapeSpecialCharacters, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaType, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessFile, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessSupportingFileData, processOpenAPI, processOpts, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toSetter, toVarName, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeReservedWord, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModels, postProcessOperations, postProcessSupportingFileData, processOpenAPI, processOpts, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

字段详细资料

invokerPackage

protected String invokerPackage

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

构造器详细资料

StaticHtmlGenerator

public StaticHtmlGenerator()

方法详细资料

escapeText

public String escapeText(String input)

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

指定者:

escapeText 在接口中 CodegenConfig

覆盖:

escapeText 在类中 DefaultCodegen

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

getTypeDeclaration

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

从类复制的说明: DefaultCodegen

Output the type declaration of the property

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string presentation of the property type

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

escapeQuotationMark

public String escapeQuotationMark(String input)

从类复制的说明: DefaultCodegen

Escape single and/or double quote to avoid code injection

指定者:

escapeQuotationMark 在接口中 CodegenConfig

覆盖:

escapeQuotationMark 在类中 DefaultCodegen

参数:

input - String to be cleaned up

返回:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

从类复制的说明: DefaultCodegen

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

指定者:

escapeUnsafeCharacters 在接口中 CodegenConfig

覆盖:

escapeUnsafeCharacters 在类中 DefaultCodegen

参数:

input - String to be cleaned up

返回:

string with unsafe characters removed or escaped

processCompiler

public com.samskivert.mustache.Mustache.Compiler processCompiler(com.samskivert.mustache.Mustache.Compiler compiler)

Markdown conversion emits HTML and by default, the Mustache Mustache.Compiler will escape HTML. For example a summary "Text with **bold**" is converted from Markdown to HTML as "Text with <strong>bold</strong> text" and then the default compiler with HTML escaping on turns this into "Text with <strong>bold</strong> text". Here, we disable escaping by setting the compiler to Escapers.NONE

指定者:

processCompiler 在接口中 CodegenConfig

覆盖:

processCompiler 在类中 DefaultCodegen

toHtml

public String toHtml(String input)

Convert Markdown text to HTML

参数:

input - text in Markdown; may be null.

返回:

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

toModelName

public String toModelName(String name)

从类复制的说明: DefaultCodegen

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

指定者:

toModelName 在接口中 CodegenConfig

覆盖:

toModelName 在类中 DefaultCodegen

参数:

name - the name of the model

返回:

capitalized model name

preprocessOpenAPI

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

指定者:

preprocessOpenAPI 在接口中 CodegenConfig

覆盖:

preprocessOpenAPI 在类中 DefaultCodegen

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

指定者:

postProcessParameter 在接口中 CodegenConfig

覆盖:

postProcessParameter 在类中 DefaultCodegen

postProcessModelProperty

public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)

指定者:

postProcessModelProperty 在接口中 CodegenConfig

覆盖:

postProcessModelProperty 在类中 DefaultCodegen