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

java.lang.Object
- org.openapitools.codegen.DefaultCodegen
- - org.openapitools.codegen.languages.AbstractCppCodegen
  - - org.openapitools.codegen.languages.CppRestSdkClientCodegen

所有已实现的接口:: CodegenConfig

public class CppRestSdkClientCodegen
extends AbstractCppCodegen

字段概要

字段
限定符和类型	字段和说明
`protected String`	`declspec`
`static String`	`DECLSPEC`
`static String`	`DEFAULT_INCLUDE`
`protected String`	`defaultInclude`
`static String`	`GENERATE_GMOCKS_FOR_APIS`
`protected String`	`packageVersion`

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

构造器概要

构造器
构造器和说明

CppRestSdkClientCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiFileFolder()` Location to write api files.
`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
`CodegenOperation`	`fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schema, io.swagger.v3.oas.models.OpenAPI openAPI)` Convert OAS Operation object to Codegen Operation 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.
`protected boolean`	`isFileSchema(CodegenProperty property)`
`String`	`modelFileFolder()` Location to write model files.
`Map<String,Object>`	`postProcessAllModels(Map<String,Object> models)`
`void`	`postProcessModelProperty(CodegenModel model, CodegenProperty property)`
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)`
`void`	`postProcessParameter(CodegenParameter parameter)`
`void`	`processOpts()`
`String`	`toApiFilename(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`	`toModelFilename(String name)` Return the capitalized file name of the model
`String`	`toModelImport(String name)` Return the fully-qualified "Model" name for import

从类继承的方法 org.openapitools.codegen.languages.AbstractCppCodegen
escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, fromProperty, getTypeDeclaration, postProcessFile, toApiName, toBooleanGetter, toModelName, toOperationId, toParamName, toVarName

从类继承的方法 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, fromParameter, 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, 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, postProcessModels, 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, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelTestFilename, 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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessModels, 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, toApiDocFilename, toApiImport, toApiTestFilename, toApiVarName, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - DECLSPEC
```
public static final String DECLSPEC
```
    另请参阅:
    
    常量字段值
  - DEFAULT_INCLUDE
```
public static final String DEFAULT_INCLUDE
```
    另请参阅:
    
    常量字段值
  - GENERATE_GMOCKS_FOR_APIS
```
public static final String GENERATE_GMOCKS_FOR_APIS
```
    另请参阅:
    
    常量字段值
  - packageVersion
```
protected String packageVersion
```
  - declspec
```
protected String declspec
```
  - defaultInclude
```
protected String defaultInclude
```
- 构造器详细资料
  - CppRestSdkClientCodegen
```
public CppRestSdkClientCodegen()
```
- 方法详细资料
  - 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 在类中 AbstractCppCodegen
  - 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
  - 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
  - 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
  - fromOperation
```
public CodegenOperation fromOperation(String path,
                                      String httpMethod,
                                      io.swagger.v3.oas.models.Operation operation,
                                      Map<String,io.swagger.v3.oas.models.media.Schema> schema,
                                      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
    
    schema - a map of OAS models
    
    openAPI - a OAS object representing the spec
    
    返回:
    
    Codegen Operation object
  - postProcessModelProperty
```
public void postProcessModelProperty(CodegenModel model,
                                     CodegenProperty property)
```
    指定者:
    
    postProcessModelProperty 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessModelProperty 在类中 DefaultCodegen
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)
```
    指定者:
    
    postProcessOperationsWithModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessOperationsWithModels 在类中 DefaultCodegen
  - isFileSchema
```
protected boolean isFileSchema(CodegenProperty property)
```
  - 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
  - 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
  - toDefaultValue
```
public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
```
    从类复制的说明: DefaultCodegen
    
    Return the default value of the property
    
    覆盖:
    
    toDefaultValue 在类中 DefaultCodegen
    
    参数:
    
    p - Property schema
    
    返回:
    
    string presentation of the default value of the property
  - postProcessParameter
```
public void postProcessParameter(CodegenParameter parameter)
```
    指定者:
    
    postProcessParameter 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessParameter 在类中 DefaultCodegen
  - 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
    
    另请参阅:
    
    Schema
  - postProcessAllModels
```
public Map<String,Object> postProcessAllModels(Map<String,Object> models)
```
    指定者:
    
    postProcessAllModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessAllModels 在类中 DefaultCodegen

类 CppRestSdkClientCodegen

字段概要

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

构造器概要

方法概要

从类继承的方法 org.openapitools.codegen.languages.AbstractCppCodegen

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

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

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

字段详细资料

DECLSPEC

DEFAULT_INCLUDE

GENERATE_GMOCKS_FOR_APIS

packageVersion

declspec

defaultInclude

构造器详细资料

CppRestSdkClientCodegen

方法详细资料

getTag

getName

getHelp

processOpts

modelFileFolder

apiFileFolder

toModelImport

fromModel

fromOperation

postProcessModelProperty

postProcessOperationsWithModels

isFileSchema

toModelFilename

toApiFilename

getTypeDeclaration

toDefaultValue

postProcessParameter

getSchemaType

postProcessAllModels