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

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

所有已实现的接口:: CodegenConfig

public class NodeJSServerCodegen
extends DefaultCodegen
implements CodegenConfig

字段概要

字段
限定符和类型	字段和说明
`protected String`	`apiVersion`
`protected String`	`defaultServerPort`
`static String`	`EXPORTED_NAME`
`protected String`	`exportedName`
`static String`	`GOOGLE_CLOUD_FUNCTIONS`
`protected boolean`	`googleCloudFunctions`
`protected String`	`implFolder`
`protected String`	`projectName`
`static String`	`SERVER_PORT`

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

构造器概要

构造器
构造器和说明

NodeJSServerCodegen()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`apiFileFolder()` Location to write api files.
`String`	`apiFilename(String templateName, String tag)`
`String`	`apiPackage()`
`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`	`escapeUnsafeCharacters(String input)` override with any special text escaping logic to handle unsafe characters so as to avoid code injection
`String`	`getExportedName()`
`boolean`	`getGoogleCloudFunctions()`
`String`	`getHelp()` Returns human-friendly help for the generator.
`String`	`getName()` Configures a friendly name for the generator.
`CodegenType`	`getTag()` Configures the type of generator.
`Map<String,Object>`	`postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)`
`Map<String,Object>`	`postProcessSupportingFileData(Map<String,Object> objs)`
`void`	`preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)`
`void`	`processOpts()`
`String`	`removeNonNameElementToCamelCase(String name)` Remove characters not suitable for variable or method name from the input and camelize it
`void`	`setExportedName(String name)`
`void`	`setGoogleCloudFunctions(boolean value)`
`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

从类继承的方法 org.openapitools.codegen.DefaultCodegen
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiTemplateFiles, apiTestFileFolder, 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, getSchemaType, getSymbolName, getterAndSetterCapitalize, getTypeDeclaration, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperations, postProcessParameter, processCompiler, processOpenAPI, 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, toBooleanGetter, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelDocFilename, toModelFilename, 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, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiTemplateFiles, apiTestFileFolder, 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, getTypeDeclaration, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessModels, postProcessOperations, postProcessParameter, 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, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

- 字段详细资料
  - implFolder
```
protected String implFolder
```
  - GOOGLE_CLOUD_FUNCTIONS
```
public static final String GOOGLE_CLOUD_FUNCTIONS
```
    另请参阅:
    
    常量字段值
  - EXPORTED_NAME
```
public static final String EXPORTED_NAME
```
    另请参阅:
    
    常量字段值
  - SERVER_PORT
```
public static final String SERVER_PORT
```
    另请参阅:
    
    常量字段值
  - apiVersion
```
protected String apiVersion
```
  - projectName
```
protected String projectName
```
  - defaultServerPort
```
protected String defaultServerPort
```
  - googleCloudFunctions
```
protected boolean googleCloudFunctions
```
  - exportedName
```
protected String exportedName
```
- 构造器详细资料
  - NodeJSServerCodegen
```
public NodeJSServerCodegen()
```
- 方法详细资料
  - apiPackage
```
public String apiPackage()
```
    指定者:
    
    apiPackage 在接口中 CodegenConfig
    
    覆盖:
    
    apiPackage 在类中 DefaultCodegen
  - 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
  - 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"
  - 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
  - apiFilename
```
public String apiFilename(String templateName,
                          String tag)
```
    指定者:
    
    apiFilename 在接口中 CodegenConfig
    
    覆盖:
    
    apiFilename 在类中 DefaultCodegen
  - 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
  - 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
  - getGoogleCloudFunctions
```
public boolean getGoogleCloudFunctions()
```
  - setGoogleCloudFunctions
```
public void setGoogleCloudFunctions(boolean value)
```
  - getExportedName
```
public String getExportedName()
```
  - setExportedName
```
public void setExportedName(String name)
```
  - postProcessOperationsWithModels
```
public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)
```
    指定者:
    
    postProcessOperationsWithModels 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessOperationsWithModels 在类中 DefaultCodegen
  - processOpts
```
public void processOpts()
```
    指定者:
    
    processOpts 在接口中 CodegenConfig
    
    覆盖:
    
    processOpts 在类中 DefaultCodegen
  - preprocessOpenAPI
```
public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
```
    指定者:
    
    preprocessOpenAPI 在接口中 CodegenConfig
    
    覆盖:
    
    preprocessOpenAPI 在类中 DefaultCodegen
  - postProcessSupportingFileData
```
public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
```
    指定者:
    
    postProcessSupportingFileData 在接口中 CodegenConfig
    
    覆盖:
    
    postProcessSupportingFileData 在类中 DefaultCodegen
  - removeNonNameElementToCamelCase
```
public String removeNonNameElementToCamelCase(String name)
```
    从类复制的说明: DefaultCodegen
    
    Remove characters not suitable for variable or method name from the input and camelize it
    
    覆盖:
    
    removeNonNameElementToCamelCase 在类中 DefaultCodegen
    
    参数:
    
    name - string to be camelize
    
    返回:
    
    camelized string
  - 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
  - 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

类 NodeJSServerCodegen

字段概要

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

构造器概要

方法概要

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

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

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

字段详细资料

implFolder

GOOGLE_CLOUD_FUNCTIONS

EXPORTED_NAME

SERVER_PORT

apiVersion

projectName

defaultServerPort

googleCloudFunctions

exportedName

构造器详细资料

NodeJSServerCodegen

方法详细资料

apiPackage

getTag

getName

getHelp

toApiName

toApiFilename

apiFilename

escapeReservedWord

apiFileFolder

getGoogleCloudFunctions

setGoogleCloudFunctions

getExportedName

setExportedName

postProcessOperationsWithModels

processOpts

preprocessOpenAPI

postProcessSupportingFileData

removeNonNameElementToCamelCase

escapeUnsafeCharacters

escapeQuotationMark