public class RubyClientCodegen extends DefaultCodegen
| 限定符和类型 | 字段和说明 |
|---|---|
protected String |
apiDocPath |
protected static int |
emptyMethodNameCounter |
static String |
GEM_AUTHOR |
static String |
GEM_AUTHOR_EMAIL |
static String |
GEM_DESCRIPTION |
static String |
GEM_HOMEPAGE |
static String |
GEM_LICENSE |
static String |
GEM_NAME |
static String |
GEM_REQUIRED_RUBY_VERSION |
static String |
GEM_SUMMARY |
static String |
GEM_VERSION |
protected String |
gemAuthor |
protected String |
gemAuthorEmail |
protected String |
gemDescription |
protected String |
gemHomepage |
protected String |
gemLicense |
protected String |
gemName |
protected String |
gemRequiredRubyVersion |
protected String |
gemSummary |
protected String |
gemVersion |
protected String |
libFolder |
protected String |
modelDocPath |
static String |
MODULE_NAME |
protected String |
moduleName |
protected String |
specFolder |
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| 构造器和说明 |
|---|
RubyClientCodegen() |
| 限定符和类型 | 方法和说明 |
|---|---|
String |
apiDocFileFolder() |
String |
apiFileFolder() |
String |
apiTestFileFolder() |
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 |
generateGemName(String moduleName)
Generate Ruby gem name from the module name, e.g. use "openapi_client" for "OpenAPIClient".
|
String |
generateModuleName(String gemName)
Generate Ruby module name from the gem name, e.g. use "OpenAPIClient" for "openapi_client".
|
String |
getHelp() |
String |
getName() |
String |
getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
returns the OpenAPI type for the property.
|
CodegenType |
getTag() |
String |
getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)
Output the type declaration of the property
|
String |
modelDocFileFolder() |
String |
modelFileFolder() |
String |
modelTestFileFolder() |
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) |
void |
processOpts() |
void |
setGemAuthor(String gemAuthor) |
void |
setGemAuthorEmail(String gemAuthorEmail) |
void |
setGemDescription(String gemDescription) |
void |
setGemHomepage(String gemHomepage) |
void |
setGemLicense(String gemLicense) |
void |
setGemName(String gemName) |
void |
setGemRequiredRubyVersion(String gemRequiredRubyVersion) |
void |
setGemSummary(String gemSummary) |
void |
setGemVersion(String gemVersion) |
void |
setModuleName(String moduleName) |
void |
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.
|
void |
setParameterExampleValue(CodegenParameter codegenParameter,
io.swagger.v3.oas.models.parameters.Parameter parameter)
Return the example value of the parameter.
|
boolean |
shouldOverwrite(String filename) |
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 |
toApiImport(String name)
Return the fully-qualified "Api" name for import
|
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 |
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 |
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 |
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 |
toRegularExpression(String pattern)
Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
|
String |
toVarName(String name)
Return the variable name by removing invalid characters and proper escaping if
it's a reserved word.
|
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, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, 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, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelImport, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, 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, postProcessModelProperty, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiVarName, toBooleanGetter, toGetter, toModelImport, toSetter, typeMapping, vendorExtensionsprotected String gemName
protected String moduleName
protected String gemVersion
protected String specFolder
protected String libFolder
protected String gemLicense
protected String gemRequiredRubyVersion
protected String gemHomepage
protected String gemSummary
protected String gemDescription
protected String gemAuthor
protected String gemAuthorEmail
protected String apiDocPath
protected String modelDocPath
protected static int emptyMethodNameCounter
public void processOpts()
processOpts 在接口中 CodegenConfigpublic CodegenType getTag()
getTag 在接口中 CodegenConfiggetTag 在类中 DefaultCodegenpublic String getName()
getName 在接口中 CodegenConfiggetName 在类中 DefaultCodegenpublic String getHelp()
getHelp 在接口中 CodegenConfiggetHelp 在类中 DefaultCodegenpublic String generateModuleName(String gemName)
gemName - Ruby gem namepublic String generateGemName(String moduleName)
moduleName - Ruby module naamepublic String apiFileFolder()
apiFileFolder 在接口中 CodegenConfigapiFileFolder 在类中 DefaultCodegenpublic String modelFileFolder()
modelFileFolder 在接口中 CodegenConfigmodelFileFolder 在类中 DefaultCodegenpublic String apiTestFileFolder()
apiTestFileFolder 在接口中 CodegenConfigapiTestFileFolder 在类中 DefaultCodegenpublic String modelTestFileFolder()
modelTestFileFolder 在接口中 CodegenConfigmodelTestFileFolder 在类中 DefaultCodegenpublic String apiDocFileFolder()
apiDocFileFolder 在接口中 CodegenConfigapiDocFileFolder 在类中 DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder 在接口中 CodegenConfigmodelDocFileFolder 在类中 DefaultCodegenpublic String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegengetSchemaType 在类中 DefaultCodegenschema - property schemapublic String toModelName(String name)
DefaultCodegentoModelName 在接口中 CodegenConfigtoModelName 在类中 DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename 在接口中 CodegenConfigtoModelFilename 在类中 DefaultCodegenname - the model namepublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename 在接口中 CodegenConfigtoModelDocFilename 在类中 DefaultCodegenname - the model namepublic String toApiFilename(String name)
DefaultCodegentoApiFilename 在接口中 CodegenConfigtoApiFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename 在接口中 CodegenConfigtoApiDocFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toApiTestFilename(String name)
DefaultCodegentoApiTestFilename 在接口中 CodegenConfigtoApiTestFilename 在类中 DefaultCodegenname - the file name of the Apipublic String toModelTestFilename(String name)
DefaultCodegentoModelTestFilename 在接口中 CodegenConfigtoModelTestFilename 在类中 DefaultCodegenname - the model namepublic String toApiName(String name)
DefaultCodegentoApiName 在接口中 CodegenConfigtoApiName 在类中 DefaultCodegenname - the name of the Apipublic String toEnumValue(String value, String datatype)
DefaultCodegentoEnumValue 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumVarName(String name, String datatype)
DefaultCodegentoEnumVarName 在类中 DefaultCodegenname - enum variable namedatatype - data typepublic String toEnumName(CodegenProperty property)
DefaultCodegentoEnumName 在类中 DefaultCodegenproperty - Codegen propertypublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels 在接口中 CodegenConfigpostProcessModels 在类中 DefaultCodegenpublic String toOperationId(String operationId)
DefaultCodegenoperationId - operation IDpublic String toApiImport(String name)
DefaultCodegentoApiImport 在接口中 CodegenConfigtoApiImport 在类中 DefaultCodegenname - the name of the "Api"public void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue 在类中 DefaultCodegenp - Codegen parameterpublic void setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter)
setParameterExampleValue 在类中 DefaultCodegencodegenParameter - Codegen parameterparameter - Parameterpublic void setGemName(String gemName)
public void setModuleName(String moduleName)
public void setGemVersion(String gemVersion)
public void setGemDescription(String gemDescription)
public void setGemSummary(String gemSummary)
public void setGemLicense(String gemLicense)
public void setGemRequiredRubyVersion(String gemRequiredRubyVersion)
public void setGemHomepage(String gemHomepage)
public void setGemAuthor(String gemAuthor)
public void setGemAuthorEmail(String gemAuthorEmail)
public boolean shouldOverwrite(String filename)
shouldOverwrite 在接口中 CodegenConfigshouldOverwrite 在类中 DefaultCodegenpublic String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord 在接口中 CodegenConfigescapeReservedWord 在类中 DefaultCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenschema - property schemapublic String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegentoDefaultValue 在类中 DefaultCodegenp - Property schemapublic String toVarName(String name)
DefaultCodegentoVarName 在类中 DefaultCodegenname - the variable namepublic String toRegularExpression(String pattern)
DefaultCodegentoRegularExpression 在类中 DefaultCodegenpattern - the pattern (regular expression)public String toParamName(String name)
DefaultCodegentoParamName 在接口中 CodegenConfigtoParamName 在类中 DefaultCodegenname - Codegen property objectpublic String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark 在接口中 CodegenConfigescapeQuotationMark 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters 在接口中 CodegenConfigescapeUnsafeCharacters 在类中 DefaultCodegeninput - String to be cleaned uppublic void postProcessFile(File file, String fileType)
DefaultCodegenTODO: store these values in enum instead
postProcessFile 在接口中 CodegenConfigpostProcessFile 在类中 DefaultCodegenfile - file to be processedfileType - file typeCopyright © 2019. All rights reserved.