org.openapitools.codegen.languages

类 ElmClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.ElmClientCodegen

所有已实现的接口:

CodegenConfig

public class ElmClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	packageName
protected String	packageVersion

从类继承的字段 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

构造器概要

构造器

构造器和说明
ElmClientCodegen()

方法概要

限定符和类型	方法和说明
String	apiFileFolder()
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Return the escaped name of the reserved word
String	escapeUnsafeCharacters(String input) override with any special text escaping logic to handle unsafe characters so as to avoid code injection
CodegenModel	fromModel(String name, io.swagger.v3.oas.models.media.Schema schema, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert OAS Model object to Codegen Model object
CodegenProperty	fromProperty(String name, io.swagger.v3.oas.models.media.Schema p) Convert OAS Property object to Codegen Property object
CodegenResponse	fromResponse(io.swagger.v3.oas.models.OpenAPI openAPI, String responseCode, io.swagger.v3.oas.models.responses.ApiResponse resp) Convert OAS Response object to Codegen Response object
String	getHelp()
String	getName()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
String	modelFileFolder()
Map<String,Object>	postProcessAllModels(Map<String,Object> objs)
void	postProcessFile(File file, String fileType) Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> operations, List<Object> allModels)
void	postProcessParameter(CodegenParameter parameter)
void	processOpts()
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema p) Return the default value of the property
String	toEnumName(CodegenProperty property) Return the Enum name (e.g.
String	toEnumVarName(String value, String datatype) Return the sanitized variable name for enum
String	toInstantiationType(io.swagger.v3.oas.models.media.Schema p) Return the instantiation type of the property, especially for map and array
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized).
String	toVarName(String name) Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
void	updateCodegenPropertyEnum(CodegenProperty property) Update codegen property's enum by adding "enumVars" (with name and value)

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

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromOperation, fromOperation, fromParameter, fromRequestBody, fromRequestBodyToFormParameters, 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, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, 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, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumValue, toExamples, toExampleValue, toGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toSetter, typeMapping, underscore, 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, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, 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, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModelProperty, postProcessOperations, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, 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, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

字段详细资料

packageName

protected String packageName

packageVersion

protected String packageVersion

构造器详细资料

ElmClientCodegen

public ElmClientCodegen()

方法详细资料

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 DefaultCodegen

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

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

toApiName

public String toApiName(String name)

从类复制的说明: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

指定者:

toApiName 在接口中 CodegenConfig

覆盖:

toApiName 在类中 DefaultCodegen

参数:

name - the name of the Api

返回:

capitalized Api name ending with "Api"

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

toModelFilename

public String toModelFilename(String name)

从类复制的说明: DefaultCodegen

Return the capitalized file name of the model

指定者:

toModelFilename 在接口中 CodegenConfig

覆盖:

toModelFilename 在类中 DefaultCodegen

参数:

name - the model name

返回:

the file name of the model

toEnumName

public String toEnumName(CodegenProperty property)

从类复制的说明: DefaultCodegen

Return the Enum name (e.g. StatusEnum given 'status')

覆盖:

toEnumName 在类中 DefaultCodegen

参数:

property - Codegen property

返回:

the Enum name

toVarName

public String toVarName(String name)

从类复制的说明: DefaultCodegen

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

覆盖:

toVarName 在类中 DefaultCodegen

参数:

name - the variable name

返回:

the sanitized variable name

toEnumVarName

public String toEnumVarName(String value,
                            String datatype)

从类复制的说明: DefaultCodegen

Return the sanitized variable name for enum

覆盖:

toEnumVarName 在类中 DefaultCodegen

参数:

value - enum variable name

datatype - data type

返回:

the sanitized variable name for enum

toInstantiationType

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

从类复制的说明: DefaultCodegen

Return the instantiation type of the property, especially for map and array

覆盖:

toInstantiationType 在类中 DefaultCodegen

参数:

p - property schema

返回:

string presentation of the instantiation type of the property

escapeReservedWord

public String escapeReservedWord(String name)

从类复制的说明: DefaultCodegen

Return the escaped name of the reserved word

指定者:

escapeReservedWord 在接口中 CodegenConfig

覆盖:

escapeReservedWord 在类中 DefaultCodegen

参数:

name - the name to be escaped

返回:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

apiFileFolder

public String apiFileFolder()

指定者:

apiFileFolder 在接口中 CodegenConfig

覆盖:

apiFileFolder 在类中 DefaultCodegen

modelFileFolder

public String modelFileFolder()

指定者:

modelFileFolder 在接口中 CodegenConfig

覆盖:

modelFileFolder 在类中 DefaultCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema schema,
                              Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions)

从类复制的说明: DefaultCodegen

Convert OAS Model object to Codegen Model object

指定者:

fromModel 在接口中 CodegenConfig

覆盖:

fromModel 在类中 DefaultCodegen

参数:

name - the name of the model

schema - OAS Model object

allDefinitions - a map of all OAS models from the spec

返回:

Codegen Model object

postProcessAllModels

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

指定者:

postProcessAllModels 在接口中 CodegenConfig

覆盖:

postProcessAllModels 在类中 DefaultCodegen

postProcessModels

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

指定者:

postProcessModels 在接口中 CodegenConfig

覆盖:

postProcessModels 在类中 DefaultCodegen

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

toDefaultValue

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

从类复制的说明: DefaultCodegen

Return the default value of the property

覆盖:

toDefaultValue 在类中 DefaultCodegen

参数:

p - Property schema

返回:

string presentation of the default value of the property

getSchemaType

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

从类复制的说明: DefaultCodegen

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

覆盖:

getSchemaType 在类中 DefaultCodegen

参数:

p - property schema

返回:

string presentation of the type

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

fromProperty

public CodegenProperty fromProperty(String name,
                                    io.swagger.v3.oas.models.media.Schema p)

从类复制的说明: DefaultCodegen

Convert OAS Property object to Codegen Property object

覆盖:

fromProperty 在类中 DefaultCodegen

参数:

name - name of the property

p - OAS property object

返回:

Codegen Property object

fromResponse

public CodegenResponse fromResponse(io.swagger.v3.oas.models.OpenAPI openAPI,
                                    String responseCode,
                                    io.swagger.v3.oas.models.responses.ApiResponse resp)

从类复制的说明: DefaultCodegen

Convert OAS Response object to Codegen Response object

覆盖:

fromResponse 在类中 DefaultCodegen

参数:

openAPI - a OAS object representing the spec

responseCode - HTTP response code

resp - OAS Response object

返回:

Codegen Response object

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

指定者:

postProcessParameter 在接口中 CodegenConfig

覆盖:

postProcessParameter 在类中 DefaultCodegen

updateCodegenPropertyEnum

public void updateCodegenPropertyEnum(CodegenProperty property)

从类复制的说明: DefaultCodegen

Update codegen property's enum by adding "enumVars" (with name and value)

覆盖:

updateCodegenPropertyEnum 在类中 DefaultCodegen

参数:

property - list of CodegenProperty

postProcessFile

public void postProcessFile(File file,
                            String fileType)

从类复制的说明: DefaultCodegen

Post-process the auto-generated file, e.g. using go-fmt to format the Go code. The file type can be "model-test", "model-doc", "model", "api", "api-test", "api-doc", "supporting-mustache", "supporting-common", "openapi-generator-ignore", "openapi-generator-version"

TODO: store these values in enum instead

指定者:

postProcessFile 在接口中 CodegenConfig

覆盖:

postProcessFile 在类中 DefaultCodegen

参数:

file - file to be processed

fileType - file type