Package io.swagger.codegen.v3.generators.scala

Class AkkaHttpServerCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

io.swagger.codegen.v3.generators.scala.AkkaHttpServerCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class AkkaHttpServerCodegen
extends AbstractScalaCodegen

Field Summary

Fields

Modifier and Type	Field	Description
protected String	artifactId
protected String	artifactVersion
protected static String	COOKIE_DATA_TYPE
protected static String	FALLBACK_DATA_TYPE
protected String	groupId
protected String	invokerPackage
protected static String	LOWERCASE_HTTP_METHOD
protected static String	PARAMS_WITH_SUPPORTED_TYPE
protected static String	PATHS
protected static String	QUERY_PARAMS_WITH_SUPPORTED_TYPE

Fields inherited from class io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

modelPropertyNaming, sourceFolder

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
AkkaHttpServerCodegen()

Method Summary

Modifier and Type	Method	Description
static void	addAllParamsWithSupportedTypes(io.swagger.codegen.v3.CodegenOperation codegenOperation)
protected static void	addLowercaseHttpMethod(io.swagger.codegen.v3.CodegenOperation codegenOperation)	Provide a lowercase representation of the http method to map to the method directives of akka http
protected static void	addPathMatcher(io.swagger.codegen.v3.CodegenOperation codegenOperation)	Split the path as a string to a list of strings to map to the path directives of akka http
protected static void	addQueryParamsWithSupportedType(io.swagger.codegen.v3.CodegenOperation codegenOperation)	Replace all not supported types of query parameters by the fallback type
io.swagger.codegen.v3.CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> schemas, io.swagger.v3.oas.models.OpenAPI openAPI)	Convert Swagger Operation object to Codegen Operation object
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
io.swagger.codegen.v3.CodegenType	getTag()
Map<String,Object>	postProcessOperations(Map<String,Object> objs)
static Map<String,Object>	setComplexTypes(Map<String,Object> objs)

Methods inherited from class io.swagger.codegen.v3.generators.scala.AbstractScalaCodegen

apiFileFolder, escapeReservedWord, escapeUnsafeCharacters, formatIdentifier, getSchemaType, getSourceFolder, getTypeDeclaration, modelFileFolder, postProcessModels, processCompiler, processOpts, setSourceFolder, stripPackageName, toDefaultValue, toInstantiationType, toModelFilename

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeQuotationMark, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toModelDocFilename, toModelImport, toModelName, toModelTestFilename, toOperationId, toParamName, toRegularExpression, toSetter, toVarName, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

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.v3.CodegenConfig

checkAliasModel, getCodeName, getPriority, isPrivileged

Field Details

groupId

protected String groupId

artifactId

protected String artifactId

artifactVersion

protected String artifactVersion

invokerPackage

protected String invokerPackage

LOWERCASE_HTTP_METHOD

protected static String LOWERCASE_HTTP_METHOD

PATHS

protected static String PATHS

FALLBACK_DATA_TYPE

protected static String FALLBACK_DATA_TYPE

COOKIE_DATA_TYPE

protected static String COOKIE_DATA_TYPE

QUERY_PARAMS_WITH_SUPPORTED_TYPE

protected static String QUERY_PARAMS_WITH_SUPPORTED_TYPE

PARAMS_WITH_SUPPORTED_TYPE

protected static String PARAMS_WITH_SUPPORTED_TYPE

Constructor Details

AkkaHttpServerCodegen

public AkkaHttpServerCodegen()

Method Details

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getName

public String getName()

getHelp

public String getHelp()

postProcessOperations

public Map<String,Object> postProcessOperations(Map<String,Object> objs)

Specified by:

postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessOperations in class DefaultCodegenConfig

setComplexTypes

public static Map<String,Object> setComplexTypes(Map<String,Object> objs)

fromOperation

public io.swagger.codegen.v3.CodegenOperation fromOperation(String path,
 String httpMethod,
 io.swagger.v3.oas.models.Operation operation,
 Map<String,io.swagger.v3.oas.models.media.Schema> schemas,
 io.swagger.v3.oas.models.OpenAPI openAPI)

Description copied from class: DefaultCodegenConfig

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

fromOperation in class DefaultCodegenConfig

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - Swagger operation object

schemas - a map of schemas

openAPI - a OpenAPI object representing the spec

Returns:

Codegen Operation object

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

addLowercaseHttpMethod

protected static void addLowercaseHttpMethod(io.swagger.codegen.v3.CodegenOperation codegenOperation)

Provide a lowercase representation of the http method to map to the method directives of akka http

See Also:

• Akka Http Documentation

addPathMatcher

protected static void addPathMatcher(io.swagger.codegen.v3.CodegenOperation codegenOperation)

Split the path as a string to a list of strings to map to the path directives of akka http

See Also:

• Akka Http Documentation

addQueryParamsWithSupportedType

protected static void addQueryParamsWithSupportedType(io.swagger.codegen.v3.CodegenOperation codegenOperation)

Replace all not supported types of query parameters by the fallback type

addAllParamsWithSupportedTypes

public static void addAllParamsWithSupportedTypes(io.swagger.codegen.v3.CodegenOperation codegenOperation)