org.openapitools.codegen.languages

类 ScalaAkkaClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractScalaCodegen

org.openapitools.codegen.languages.ScalaAkkaClientCodegen

所有已实现的接口:

CodegenConfig

public class ScalaAkkaClientCodegen
extends AbstractScalaCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	artifactId
protected String	artifactVersion
protected String	configKey
protected String	configKeyPath
protected int	defaultTimeoutInMs
protected String	groupId
protected org.slf4j.Logger	LOGGER
protected String	mainPackage
protected boolean	onlyOneSuccess If set to true, only the default response (the one with le lowest 2XX code) will be considered as a success, and all others as ApiErrors.
protected boolean	registerNonStandardStatusCodes
protected boolean	removeOAuthSecurities
protected boolean	renderJavadoc
protected String	resourcesFolder

从类继承的字段 org.openapitools.codegen.languages.AbstractScalaCodegen

invokerPackage, modelPropertyNaming, sourceFolder, stripPackageName

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

构造器概要

构造器

构造器和说明
ScalaAkkaClientCodegen()

方法概要

限定符和类型	方法和说明
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
List<CodegenSecurity>	fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemes) Convert map of OAS SecurityScheme objects to a list of Codegen Security objects
String	getHelp()
String	getName()
CodegenType	getTag()
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	processOpts()
void	setMainPackage(String mainPackage)
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	toModelName(String name) Output the proper model name (capitalized).
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	toVarName(String name) Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

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

apiFileFolder, escapeUnsafeCharacters, formatIdentifier, getSchemaType, getSourceFolder, getTypeDeclaration, modelFileFolder, postProcessFile, postProcessModels, processCompiler, setSourceFolder, stripPackageName, toInstantiationType, toModelFilename

从类继承的方法 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, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, 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, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toGetter, toModelDocFilename, toModelImport, 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, apiFileFolder, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromOperation, 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, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, vendorExtensions

字段详细资料

mainPackage

protected String mainPackage

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

resourcesFolder

protected String resourcesFolder

configKey

protected String configKey

defaultTimeoutInMs

protected int defaultTimeoutInMs

configKeyPath

protected String configKeyPath

registerNonStandardStatusCodes

protected boolean registerNonStandardStatusCodes

renderJavadoc

protected boolean renderJavadoc

removeOAuthSecurities

protected boolean removeOAuthSecurities

onlyOneSuccess

protected boolean onlyOneSuccess

If set to true, only the default response (the one with le lowest 2XX code) will be considered as a success, and all others as ApiErrors. If set to false, all responses defined in the model will be considered as a success upon reception. Only http errors, unmarshalling problems and any other RuntimeException will be considered as ApiErrors.

LOGGER

protected org.slf4j.Logger LOGGER

构造器详细资料

ScalaAkkaClientCodegen

public ScalaAkkaClientCodegen()

方法详细资料

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractScalaCodegen

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

escapeReservedWord

public String escapeReservedWord(String name)

从类复制的说明: DefaultCodegen

Return the escaped name of the reserved word

指定者:

escapeReservedWord 在接口中 CodegenConfig

覆盖:

escapeReservedWord 在类中 AbstractScalaCodegen

参数:

name - the name to be escaped

返回:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 DefaultCodegen

fromSecurity

public List<CodegenSecurity> fromSecurity(Map<String,io.swagger.v3.oas.models.security.SecurityScheme> schemes)

从类复制的说明: DefaultCodegen

Convert map of OAS SecurityScheme objects to a list of Codegen Security objects

指定者:

fromSecurity 在接口中 CodegenConfig

覆盖:

fromSecurity 在类中 DefaultCodegen

参数:

schemes - a map of OAS SecuritySchemeDefinition object

返回:

a list of Codegen Security objects

toOperationId

public String toOperationId(String operationId)

从类复制的说明: DefaultCodegen

Return the operation ID (method name)

覆盖:

toOperationId 在类中 DefaultCodegen

参数:

operationId - operation ID

返回:

the sanitized method name

toParamName

public String toParamName(String name)

从类复制的说明: DefaultCodegen

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

指定者:

toParamName 在接口中 CodegenConfig

覆盖:

toParamName 在类中 DefaultCodegen

参数:

name - Codegen property object

返回:

the sanitized parameter name

toVarName

public String toVarName(String name)

从类复制的说明: DefaultCodegen

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

覆盖:

toVarName 在类中 DefaultCodegen

参数:

name - the variable name

返回:

the sanitized variable name

toEnumName

public String toEnumName(CodegenProperty property)

从类复制的说明: DefaultCodegen

Return the Enum name (e.g. StatusEnum given 'status')

覆盖:

toEnumName 在类中 DefaultCodegen

参数:

property - Codegen property

返回:

the Enum name

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)

从类复制的说明: DefaultCodegen

Return the default value of the property

覆盖:

toDefaultValue 在类中 AbstractScalaCodegen

参数:

p - Property schema

返回:

string presentation of the default value of the property

toModelName

public String toModelName(String name)

从类复制的说明: DefaultCodegen

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

指定者:

toModelName 在接口中 CodegenConfig

覆盖:

toModelName 在类中 DefaultCodegen

参数:

name - the name of the model

返回:

capitalized model name

escapeQuotationMark

public String escapeQuotationMark(String input)

从类复制的说明: DefaultCodegen

Escape single and/or double quote to avoid code injection

指定者:

escapeQuotationMark 在接口中 CodegenConfig

覆盖:

escapeQuotationMark 在类中 AbstractScalaCodegen

参数:

input - String to be cleaned up

返回:

string with quotation mark removed or escaped

setMainPackage

public void setMainPackage(String mainPackage)