io.swagger.codegen.languages

Class RubyClientCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.RubyClientCodegen

All Implemented Interfaces:

CodegenConfig

public class RubyClientCodegen
extends DefaultCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected String	gemName
protected String	gemVersion
protected String	libFolder
protected String	moduleName

Fields inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, fileSuffix, importMapping, instantiationTypes, languageSpecificPrimitives, library, LOGGER, modelPackage, modelTemplateFiles, outputFolder, reservedWords, skipOverwrite, sortParamsByRequiredFlag, supportedLibraries, supportingFiles, supportsInheritance, templateDir, typeMapping

Constructor Summary

Constructors

Constructor and Description
RubyClientCodegen()

Method Summary

Methods

Modifier and Type	Method and Description
String	apiFileFolder()
String	escapeReservedWord(String name)
String	generateGemName(String moduleName) Generate Ruby gem name from the module name, e.g.
String	generateModuleName(String gemName) Generate Ruby module name from the gem name, e.g.
String	getHelp()
String	getName()
String	getSwaggerType(io.swagger.models.properties.Property p) returns the swagger type for the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.models.properties.Property p)
String	modelFileFolder()
void	processOpts()
void	setGemName(String gemName)
void	setGemVersion(String gemVersion)
void	setModuleName(String moduleName)
String	toApiFilename(String name)
String	toApiImport(String name)
String	toApiName(String name)
String	toDefaultValue(io.swagger.models.properties.Property p)
String	toModelFilename(String name)
String	toModelImport(String name)
String	toModelName(String name)
String	toOperationId(String operationId)
String	toParamName(String name)
String	toVarName(String name)

Methods inherited from class io.swagger.codegen.DefaultCodegen

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, defaultIncludes, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromResponse, fromSecurity, generateExamplePath, getLibrary, getOutputDir, getterAndSetterCapitalize, getTypeDeclaration, importMapping, initialCaps, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, needToImport, outputFolder, postProcessModels, postProcessOperations, postProcessSupportingFileData, preprocessSwagger, processSwagger, removeNonNameElementToCamelCase, reservedWords, sanitizeName, setApiPackage, setLibrary, setModelPackage, setNonArrayMapProperty, setOutputDir, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, toApiVarName, toEnumName, toExamples, toInstantiationType, typeMapping, underscore

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiFilename, apiPackage, apiTemplateFiles, cliOptions, defaultIncludes, escapeText, fileSuffix, fromModel, fromModel, fromOperation, fromOperation, fromSecurity, generateExamplePath, getLibrary, getOutputDir, getTypeDeclaration, importMapping, instantiationTypes, isSkipOverwrite, languageSpecificPrimitives, modelPackage, modelTemplateFiles, outputFolder, postProcessModels, postProcessOperations, postProcessSupportingFileData, preprocessSwagger, processSwagger, reservedWords, setLibrary, setOutputDir, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, toApiVarName, typeMapping

Field Detail

gemName

protected String gemName

moduleName

protected String moduleName

gemVersion

protected String gemVersion

libFolder

protected String libFolder

Constructor Detail

RubyClientCodegen

public RubyClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class DefaultCodegen

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

getName

public String getName()

Specified by:

getName in interface CodegenConfig

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

generateModuleName

public String generateModuleName(String gemName)

Generate Ruby module name from the gem name, e.g. use "SwaggerClient" for "swagger_client".

generateGemName

public String generateGemName(String moduleName)

Generate Ruby gem name from the module name, e.g. use "swagger_client" for "SwaggerClient".

escapeReservedWord

public String escapeReservedWord(String name)

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

getTypeDeclaration

public String getTypeDeclaration(io.swagger.models.properties.Property p)

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

getSwaggerType

public String getSwaggerType(io.swagger.models.properties.Property p)

Description copied from class: DefaultCodegen

returns the swagger type for the property

Overrides:

getSwaggerType in class DefaultCodegen

toDefaultValue

public String toDefaultValue(io.swagger.models.properties.Property p)

Overrides:

toDefaultValue in class DefaultCodegen

toVarName

public String toVarName(String name)

Overrides:

toVarName in class DefaultCodegen

toParamName

public String toParamName(String name)

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class DefaultCodegen

toModelName

public String toModelName(String name)

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

toModelFilename

public String toModelFilename(String name)

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

toApiFilename

public String toApiFilename(String name)

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

toApiName

public String toApiName(String name)

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

toOperationId

public String toOperationId(String operationId)

Overrides:

toOperationId in class DefaultCodegen

toModelImport

public String toModelImport(String name)

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

toApiImport

public String toApiImport(String name)

Specified by:

toApiImport in interface CodegenConfig

Overrides:

toApiImport in class DefaultCodegen

setGemName

public void setGemName(String gemName)

setModuleName

public void setModuleName(String moduleName)

setGemVersion

public void setGemVersion(String gemVersion)