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

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

所有已实现的接口:: CodegenConfig

public class BashClientCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`protected String`	`apiDocPath`
`static String`	`APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME`
`protected String`	`apiKeyAuthEnvironmentVariable`
`protected String`	`apiVersion`
`static String`	`BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME`
`protected String`	`basicAuthEnvironmentVariable`
`static String`	`CURL_OPTIONS`
`protected String`	`curlOptions`
`static String`	`GENERATE_BASH_COMPLETION`
`static String`	`GENERATE_ZSH_COMPLETION`
`protected boolean`	`generateBashCompletion`
`protected boolean`	`generateZshCompletion`
`static String`	`HOST_ENVIRONMENT_VARIABLE_NAME`
`protected String`	`hostEnvironmentVariable`
`protected String`	`modelDocPath`
`static String`	`PROCESS_MARKDOWN`
`protected boolean`	`processMarkdown`
`static String`	`SCRIPT_NAME`
`protected String`	`scriptName`

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

构造器概要

构造器
构造器和说明

BashClientCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiDocFileFolder()`
`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`	`escapeText(String input)` Override with any special text escaping logic
`String`	`escapeUnsafeCharacters(String input)` Override with any special text escaping logic to handle unsafe characters so as to avoid code injection.
`CodegenOperation`	`fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions, io.swagger.v3.oas.models.OpenAPI openAPI)` Convert OAS Operation object to Codegen Operation object
`CodegenParameter`	`fromParameter(io.swagger.v3.oas.models.parameters.Parameter param, Set<String> imports)` Convert OpenAPI Parameter object to Codegen Parameter 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 - schema type conversion.
`CodegenType`	`getTag()` Configures the type of generator.
`String`	`getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)` Optional - type declaration.
`String`	`modelDocFileFolder()`
`String`	`modelFileFolder()` Location to write model files.
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)` Preprocess original properties from the OpenAPI definition where necessary.
`void`	`processOpts()`
`void`	`setApiKeyAuthEnvironmentVariable(String apiKeyAuthEnvironmentVariable)`
`void`	`setBasicAuthEnvironmentVariable(String basicAuthEnvironmentVariable)`
`void`	`setCurlOptions(String curlOptions)`
`void`	`setGenerateBashCompletion(boolean generateBashCompletion)`
`void`	`setGenerateZshCompletion(boolean generateZshCompletion)`
`void`	`setHostEnvironmentVariable(String hostEnvironmentVariable)`
`void`	`setParameterExampleValue(CodegenParameter p)` Return the example value of the parameter.
`void`	`setProcessMarkdown(boolean processMarkdown)`
`void`	`setScriptName(String scriptName)`
`String`	`toApiDocFilename(String name)` Return the file name of the Api Documentation
`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

从类继承的方法 org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, 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, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, 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, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelImport, toModelName, toModelTestFilename, toOperationId, 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, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, 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, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessOperationsWithModels, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelImport, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - apiVersion
```
protected String apiVersion
```
  - curlOptions
```
protected String curlOptions
```
  - processMarkdown
```
protected boolean processMarkdown
```
  - scriptName
```
protected String scriptName
```
  - generateBashCompletion
```
protected boolean generateBashCompletion
```
  - generateZshCompletion
```
protected boolean generateZshCompletion
```
  - hostEnvironmentVariable
```
protected String hostEnvironmentVariable
```
  - basicAuthEnvironmentVariable
```
protected String basicAuthEnvironmentVariable
```
  - apiKeyAuthEnvironmentVariable
```
protected String apiKeyAuthEnvironmentVariable
```
  - apiDocPath
```
protected String apiDocPath
```
  - modelDocPath
```
protected String modelDocPath
```
  - CURL_OPTIONS
```
public static final String CURL_OPTIONS
```
    另请参阅:
    
    常量字段值
  - PROCESS_MARKDOWN
```
public static final String PROCESS_MARKDOWN
```
    另请参阅:
    
    常量字段值
  - SCRIPT_NAME
```
public static final String SCRIPT_NAME
```
    另请参阅:
    
    常量字段值
  - GENERATE_BASH_COMPLETION
```
public static final String GENERATE_BASH_COMPLETION
```
    另请参阅:
    
    常量字段值
  - GENERATE_ZSH_COMPLETION
```
public static final String GENERATE_ZSH_COMPLETION
```
    另请参阅:
    
    常量字段值
  - HOST_ENVIRONMENT_VARIABLE_NAME
```
public static final String HOST_ENVIRONMENT_VARIABLE_NAME
```
    另请参阅:
    
    常量字段值
  - BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME
```
public static final String BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME
```
    另请参阅:
    
    常量字段值
  - APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME
```
public static final String APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - BashClientCodegen
```
public BashClientCodegen()
```
- 方法详细资料
  - getTag
```
public CodegenType getTag()
```
    Configures the type of generator.
    
    指定者:
    
    getTag 在接口中 CodegenConfig
    
    覆盖:
    
    getTag 在类中 DefaultCodegen
    
    返回:
    
    the CodegenType for this generator
  - 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
  - setCurlOptions
```
public void setCurlOptions(String curlOptions)
```
  - setProcessMarkdown
```
public void setProcessMarkdown(boolean processMarkdown)
```
  - setScriptName
```
public void setScriptName(String scriptName)
```
  - setGenerateBashCompletion
```
public void setGenerateBashCompletion(boolean generateBashCompletion)
```
  - setGenerateZshCompletion
```
public void setGenerateZshCompletion(boolean generateZshCompletion)
```
  - setHostEnvironmentVariable
```
public void setHostEnvironmentVariable(String hostEnvironmentVariable)
```
  - setBasicAuthEnvironmentVariable
```
public void setBasicAuthEnvironmentVariable(String basicAuthEnvironmentVariable)
```
  - setApiKeyAuthEnvironmentVariable
```
public void setApiKeyAuthEnvironmentVariable(String apiKeyAuthEnvironmentVariable)
```
  - 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
  - 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
  - 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 - schema type conversion. This is used to map OpenAPI types in a `Property` 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
    
    另请参阅:
    
    Schema
  - fromParameter
```
public CodegenParameter fromParameter(io.swagger.v3.oas.models.parameters.Parameter param,
                                      Set<String> imports)
```
    Convert OpenAPI Parameter object to Codegen Parameter object
    
    覆盖:
    
    fromParameter 在类中 DefaultCodegen
    
    参数:
    
    param - OpenAPI parameter object
    
    imports - set of imports for library/package/module
    
    返回:
    
    Codegen Parameter object
  - escapeText
```
public String escapeText(String input)
```
    Override with any special text escaping logic
    
    指定者:
    
    escapeText 在接口中 CodegenConfig
    
    覆盖:
    
    escapeText 在类中 DefaultCodegen
  - 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)
```
    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
  - fromOperation
```
public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.v3.oas.models.Operation operation,
                                      Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
                                      io.swagger.v3.oas.models.OpenAPI openAPI)
```
    从类复制的说明: DefaultCodegen
    
    Convert OAS Operation object to Codegen Operation object
    
    指定者:
    
    fromOperation 在接口中 CodegenConfig
    
    覆盖:
    
    fromOperation 在类中 DefaultCodegen
    
    参数:
    
    path - the path of the operation
    
    httpMethod - HTTP method
    
    operation - OAS operation object
    
    definitions - a map of OAS models
    
    openAPI - a OAS object representing the spec
    
    返回:
    
    Codegen Operation object
  - preprocessOpenAPI
```
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
```
    Preprocess original properties from the OpenAPI definition where necessary.
    
    指定者:
    
    preprocessOpenAPI 在接口中 CodegenConfig
    
    覆盖:
    
    preprocessOpenAPI 在类中 DefaultCodegen
    
    参数:
    
    openAPI - [description]
  - setParameterExampleValue
```
public void setParameterExampleValue(CodegenParameter p)
```
    从类复制的说明: DefaultCodegen
    
    Return the example value of the parameter.
    
    覆盖:
    
    setParameterExampleValue 在类中 DefaultCodegen
    
    参数:
    
    p - Codegen parameter
  - 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

类 BashClientCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

apiVersion

curlOptions

processMarkdown

scriptName

generateBashCompletion

generateZshCompletion

hostEnvironmentVariable

basicAuthEnvironmentVariable

apiKeyAuthEnvironmentVariable

apiDocPath

modelDocPath

CURL_OPTIONS

PROCESS_MARKDOWN

SCRIPT_NAME

GENERATE_BASH_COMPLETION

GENERATE_ZSH_COMPLETION

HOST_ENVIRONMENT_VARIABLE_NAME

BASIC_AUTH_ENVIRONMENT_VARIABLE_NAME

APIKEY_AUTH_ENVIRONMENT_VARIABLE_NAME

构造器详细资料

BashClientCodegen

方法详细资料

getTag

getName

getHelp

processOpts

setCurlOptions

setProcessMarkdown

setScriptName

setGenerateBashCompletion

setGenerateZshCompletion

setHostEnvironmentVariable

setBasicAuthEnvironmentVariable

setApiKeyAuthEnvironmentVariable

escapeReservedWord

modelFileFolder

apiFileFolder

apiDocFileFolder

modelDocFileFolder

toModelDocFilename

toApiDocFilename

getTypeDeclaration

getSchemaType

fromParameter

escapeText

escapeQuotationMark

escapeUnsafeCharacters

fromOperation

preprocessOpenAPI

setParameterExampleValue

toModelFilename