org.openapitools.codegen.languages

类 ElixirClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.ElixirClientCodegen

所有已实现的接口:

CodegenConfig

public class ElixirClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	apiVersion
protected static String	defaultModuleName
protected static String	defaultPackageName
protected String	moduleName

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

构造器概要

构造器

构造器和说明
ElixirClientCodegen()

方法概要

限定符和类型	方法和说明
String	apiFileFolder() Location to write api files.
String	escapeQuotationMark(String input) Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name) Escapes a reserved word as defined in the `reservedWords` array.
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 model, Map<String,io.swagger.v3.oas.models.media.Schema> allDefinitions) Convert OAS Model object to Codegen Model object
String	getHelp() Returns human-friendly help for the generator.
String	getName() Configures a friendly name for the generator.
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) Optional - OpenAPI type conversion.
CodegenType	getTag() Configures the type of generator.
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Optional - type declaration.
String	modelFileFolder() Location to write model files.
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
void	processOpts()
void	setModuleName(String moduleName)
String	toApiFilename(String name) Return the file name of the Api Test
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized).
String	toOperationId(String operationId) Return the operation ID (method name)

从类继承的方法 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, 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, 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, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessParameter, postProcessSupportingFileData, 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, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, 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, 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, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, postProcessSupportingFileData, 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, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

字段详细资料

apiVersion

protected String apiVersion

moduleName

protected String moduleName

defaultModuleName

protected static final String defaultModuleName

另请参阅:

常量字段值

defaultPackageName

protected static final String defaultPackageName

另请参阅:

常量字段值

构造器详细资料

ElixirClientCodegen

public ElixirClientCodegen()

方法详细资料

getTag

public CodegenType getTag()

Configures the type of generator.

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

返回:

the CodegenType for this generator

另请参阅:

CodegenType

getName

public String getName()

Configures a friendly name for the generator. This will be used by the generator to select the library with the -g flag.

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

返回:

the friendly name for the generator

getHelp

public String getHelp()

Returns human-friendly help for the generator. Provide the consumer with help tips, parameters here

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

返回:

A string value for the help message

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 DefaultCodegen

preprocessOpenAPI

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

指定者:

preprocessOpenAPI 在接口中 CodegenConfig

覆盖:

preprocessOpenAPI 在类中 DefaultCodegen

postProcessOperationsWithModels

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

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

fromModel

public CodegenModel fromModel(String name,
                              io.swagger.v3.oas.models.media.Schema model,
                              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

model - OAS Model object

allDefinitions - a map of all OAS models from the spec

返回:

Codegen Model object

escapeReservedWord

public String escapeReservedWord(String name)

Escapes a reserved word as defined in the `reservedWords` array. Handle escaping those terms here. This logic is only called if a variable matches the reserved words

指定者:

escapeReservedWord 在接口中 CodegenConfig

覆盖:

escapeReservedWord 在类中 DefaultCodegen

参数:

name - the name to be escaped

返回:

the escaped term

modelFileFolder

public String modelFileFolder()

Location to write model files. You can use the modelPackage() as defined when the class is instantiated

指定者:

modelFileFolder 在接口中 CodegenConfig

覆盖:

modelFileFolder 在类中 DefaultCodegen

apiFileFolder

public String apiFileFolder()

Location to write api files. You can use the apiPackage() as defined when the class is instantiated

指定者:

apiFileFolder 在接口中 CodegenConfig

覆盖:

apiFileFolder 在类中 DefaultCodegen

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"

toApiFilename

public String toApiFilename(String name)

从类复制的说明: DefaultCodegen

Return the file name of the Api Test

指定者:

toApiFilename 在接口中 CodegenConfig

覆盖:

toApiFilename 在类中 DefaultCodegen

参数:

name - the file name of the Api

返回:

the file name of the 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

toOperationId

public String toOperationId(String operationId)

从类复制的说明: DefaultCodegen

Return the operation ID (method name)

覆盖:

toOperationId 在类中 DefaultCodegen

参数:

operationId - operation ID

返回:

the sanitized method name

getTypeDeclaration

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

Optional - type declaration. This is a String which is used by the templates to instantiate your types. There is typically special handling for different property types

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string value used as the `dataType` field for model templates, `returnType` for api templates

getSchemaType

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

Optional - OpenAPI type conversion. This is used to map OpenAPI types in a `Schema` into either language specific types via `typeMapping` or into complex models if there is not a mapping.

覆盖:

getSchemaType 在类中 DefaultCodegen

参数:

p - property schema

返回:

a string value of the type or complex model for this property

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

setModuleName

public void setModuleName(String moduleName)