LuaClientCodegen (openapi-generator (core library) 3.3.4.2 API)

java.lang.Object
- org.openapitools.codegen.DefaultCodegen
- - org.openapitools.codegen.languages.LuaClientCodegen

所有已实现的接口:: CodegenConfig

public class LuaClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`protected String`	`apiDocPath`
`protected String`	`luaRocksFilename`
`protected String`	`modelDocPath`
`protected String`	`packageName`
`protected String`	`packageVersion`
`protected String`	`specFolder`

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

构造器概要

构造器
构造器和说明

LuaClientCodegen()

构造器
构造器和说明
`LuaClientCodegen()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiDocFileFolder()`
`String`	`apiFileFolder()`
`String`	`apiTestFileFolder()`
`Map<String,String>`	`createMapping(String key, String value)`
`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
`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`	`modelDocFileFolder()`
`String`	`modelFileFolder()`
`String`	`modelTestFileFolder()`
`protected boolean`	`needToImport(String type)` Check the type to see if it needs import the library/module/package
`Map<String,Object>`	`postProcessModels(Map<String,Object> objs)`
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)`
`void`	`postProcessParameter(CodegenParameter parameter)` Overrides postProcessParameter to add a vendor extension "x-exportParamName".
`void`	`processOpts()`
`void`	`setLuaRocksFilename(String luaRocksFilename)`
`void`	`setPackageName(String packageName)`
`void`	`setPackageVersion(String packageVersion)`
`String`	`toApiDocFilename(String name)` Return the file name of the Api Documentation
`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`	`toApiTestFilename(String name)` Return the file name of the Api Test
`String`	`toEnumDefaultValue(String value, String datatype)` Return the enum default value in the language specified format
`String`	`toEnumName(CodegenProperty property)` Return the Enum name (e.g.
`String`	`toEnumValue(String value, String datatype)` Return the enum value in the language specified format e.g. status becomes "status"
`String`	`toEnumVarName(String name, String datatype)` Return the sanitized variable name for enum
`String`	`toModelDocFilename(String name)` Return the capitalized file name of the model documentation
`String`	`toModelFilename(String name)` Return the capitalized file name of the model
`String`	`toModelImport(String name)` Return the fully-qualified "Model" name for import
`String`	`toModelName(String name)` Output the proper model name (capitalized).
`String`	`toModelTestFilename(String name)` Return the capitalized file name of the model test
`String`	`toOperationId(String operationId)` Return the operation ID (method name)
`String`	`toParamName(String name)` Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
`String`	`toVarName(String name)` Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

从类继承的方法 org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeText, 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, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, 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, toApiImport, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toRegularExpression, toSetter, toSetter, 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, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, 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, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, 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, toApiImport, toApiVarName, toBooleanGetter, toGetter, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - specFolder
```
protected String specFolder
```
  - packageName
```
protected String packageName
```
  - packageVersion
```
protected String packageVersion
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - luaRocksFilename
```
protected String luaRocksFilename
```
- 构造器详细资料
  - LuaClientCodegen
```
public LuaClientCodegen()
```
- 方法详细资料
  - 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
  - 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
  - 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
  - toParamName
```
public String toParamName(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
    
    指定者:
    
    toParamName 在接口中 CodegenConfig
    
    覆盖:
    
    toParamName 在类中 DefaultCodegen
    
    参数:
    
    name - Codegen property object
    
    返回:
    
    the sanitized parameter name
  - 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
  - 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
  - toApiTestFilename
```
public String toApiTestFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the file name of the Api Test
    
    指定者:
    
    toApiTestFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toApiTestFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the file name of the Api
    
    返回:
    
    the file name of the Api
  - toModelTestFilename
```
public String toModelTestFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the capitalized file name of the model test
    
    指定者:
    
    toModelTestFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toModelTestFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the model name
    
    返回:
    
    the file name of the model
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    Overrides postProcessParameter to add a vendor extension "x-exportParamName". This is useful when paramName starts with a lowercase letter, but we need that param to be exportable (starts with an Uppercase letter).
    
    指定者:
    
    postProcessParameter 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessParameter 在类中 DefaultCodegen
    
    参数:
    
    parameter - CodegenParameter object to be processed.
  - apiTestFileFolder
```
public String apiTestFileFolder()
```
    指定者:
    
    apiTestFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiTestFileFolder 在类中 DefaultCodegen
  - modelTestFileFolder
```
public String modelTestFileFolder()
```
    指定者:
    
    modelTestFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelTestFileFolder 在类中 DefaultCodegen
  - apiDocFileFolder
```
public String apiDocFileFolder()
```
    指定者:
    
    apiDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    apiDocFileFolder 在类中 DefaultCodegen
  - modelDocFileFolder
```
public String modelDocFileFolder()
```
    指定者:
    
    modelDocFileFolder 在接口中 CodegenConfig
    
    覆盖:
    
    modelDocFileFolder 在类中 DefaultCodegen
  - toModelDocFilename
```
public String toModelDocFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the capitalized file name of the model documentation
    
    指定者:
    
    toModelDocFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toModelDocFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the model name
    
    返回:
    
    the file name of the model
  - toApiDocFilename
```
public String toApiDocFilename(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the file name of the Api Documentation
    
    指定者:
    
    toApiDocFilename 在接口中 CodegenConfig
    
    覆盖:
    
    toApiDocFilename 在类中 DefaultCodegen
    
    参数:
    
    name - the file name of the Api
    
    返回:
    
    the file name of the Api
  - 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"
  - 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
  - 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
  - toOperationId
```
public String toOperationId(String operationId)
```
    从类复制的说明: DefaultCodegen
    
    Return the operation ID (method name)
    
    覆盖:
    
    toOperationId 在类中 DefaultCodegen
    
    参数:
    
    operationId - operation ID
    
    返回:
    
    the sanitized method name
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)
```
    指定者:
    
    postProcessOperationsWithModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessOperationsWithModels 在类中 DefaultCodegen
  - postProcessModels
```
public Map<String,Object> postProcessModels(Map<String,Object> objs)
```
    指定者:
    
    postProcessModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModels 在类中 DefaultCodegen
  - needToImport
```
protected boolean needToImport(String type)
```
    从类复制的说明: DefaultCodegen
    
    Check the type to see if it needs import the library/module/package
    
    覆盖:
    
    needToImport 在类中 DefaultCodegen
    
    参数:
    
    type - name of the type
    
    返回:
    
    true if the library/module/package of the corresponding type needs to be imported
  - setPackageName
```
public void setPackageName(String packageName)
```
  - setPackageVersion
```
public void setPackageVersion(String packageVersion)
```
  - setLuaRocksFilename
```
public void setLuaRocksFilename(String luaRocksFilename)
```
  - 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
  - createMapping
```
public Map<String,String> createMapping(String key,
                                        String value)
```
  - toEnumValue
```
public String toEnumValue(String value,
                          String datatype)
```
    从类复制的说明: DefaultCodegen
    
    Return the enum value in the language specified format e.g. status becomes "status"
    
    覆盖:
    
    toEnumValue 在类中 DefaultCodegen
    
    参数:
    
    value - enum variable name
    
    datatype - data type
    
    返回:
    
    the sanitized value for enum
  - toEnumDefaultValue
```
public String toEnumDefaultValue(String value,
                                 String datatype)
```
    从类复制的说明: DefaultCodegen
    
    Return the enum default value in the language specified format
    
    覆盖:
    
    toEnumDefaultValue 在类中 DefaultCodegen
    
    参数:
    
    value - enum variable name
    
    datatype - data type
    
    返回:
    
    the default value for the enum
  - toEnumVarName
```
public String toEnumVarName(String name,
                            String datatype)
```
    从类复制的说明: DefaultCodegen
    
    Return the sanitized variable name for enum
    
    覆盖:
    
    toEnumVarName 在类中 DefaultCodegen
    
    参数:
    
    name - enum variable name
    
    datatype - data type
    
    返回:
    
    the sanitized variable name for enum
  - toEnumName
```
public String toEnumName(CodegenProperty property)
```
    从类复制的说明: DefaultCodegen
    
    Return the Enum name (e.g. StatusEnum given 'status')
    
    覆盖:
    
    toEnumName 在类中 DefaultCodegen
    
    参数:
    
    property - Codegen property
    
    返回:
    
    the Enum name
  - toModelImport
```
public String toModelImport(String name)
```
    从类复制的说明: DefaultCodegen
    
    Return the fully-qualified "Model" name for import
    
    指定者:
    
    toModelImport 在接口中 CodegenConfig
    
    覆盖:
    
    toModelImport 在类中 DefaultCodegen
    
    参数:
    
    name - the name of the "Model"
    
    返回:
    
    the fully-qualified "Model" name for import

类 LuaClientCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

specFolder

packageName

packageVersion

apiDocPath

modelDocPath

luaRocksFilename

构造器详细资料

LuaClientCodegen

方法详细资料

getTag

getName

getHelp

processOpts

escapeReservedWord

apiFileFolder

modelFileFolder

toVarName

toParamName

toModelName

toModelFilename

toApiFilename

toApiTestFilename

toModelTestFilename

postProcessParameter

apiTestFileFolder

modelTestFileFolder

apiDocFileFolder

modelDocFileFolder

toModelDocFilename

toApiDocFilename

toApiName

getTypeDeclaration

getSchemaType

toOperationId

postProcessOperationsWithModels

postProcessModels

needToImport

setPackageName

setPackageVersion

setLuaRocksFilename

escapeQuotationMark

escapeUnsafeCharacters

createMapping

toEnumValue

toEnumDefaultValue

toEnumVarName

toEnumName

toModelImport