Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.openapitools.codegen.languages.ScalaAkkaHttpServerCodegen Maven / Gradle / Ivy
/*
* Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openapitools.codegen.languages;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.servers.Server;
import org.openapitools.codegen.*;
import org.openapitools.codegen.meta.GeneratorMetadata;
import org.openapitools.codegen.meta.Stability;
import org.openapitools.codegen.meta.features.*;
import org.openapitools.codegen.model.ModelMap;
import org.openapitools.codegen.model.OperationMap;
import org.openapitools.codegen.model.OperationsMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class ScalaAkkaHttpServerCodegen extends AbstractScalaCodegen implements CodegenConfig {
protected String groupId;
protected String artifactId;
protected String artifactVersion;
protected String invokerPackage;
protected String akkaHttpVersion;
protected boolean generateAsManagedSources;
protected boolean useApachePekko;
public static final String AKKA_HTTP_VERSION = "akkaHttpVersion";
public static final String AKKA_HTTP_VERSION_DESC = "The version of akka-http";
public static final String DEFAULT_AKKA_HTTP_VERSION = "10.1.10";
public static final String DEFAULT_PEKKO_HTTP_VERSION = "1.0.0";
public static final String GENERATE_AS_MANAGED_SOURCES = "asManagedSources";
public static final String GENERATE_AS_MANAGED_SOURCES_DESC = "Resulting files cab be used as managed resources. No build files or default controllers will be generated";
public static final boolean DEFAULT_GENERATE_AS_MANAGED_SOURCES = false;
public static final String USE_APACHE_PEKKO = "useApachePekko";
public static final String USE_APACHE_PEKKO_DESC = "Use apache pekko-http instead of akka-http.";
public static final boolean DEFAULT_USE_APACHE_PEKKO = false;
// scala-akka-http-server specific properties
private static final String IS_10_1_10_PLUS = "akkaHttp10_1_10_plus";
private static final String AKKA_IMPORT_GROUP_ID = "akkaImportGroupId";
private static final Pattern akkaVersionPattern = Pattern.compile("([0-9]+)(\\.([0-9]+))?(\\.([0-9]+))?(.\\+)?");
final Logger LOGGER = LoggerFactory.getLogger(ScalaAkkaHttpServerCodegen.class);
@Override
public CodegenType getTag() {
return CodegenType.SERVER;
}
@Override
public String getName() {
return "scala-akka-http-server";
}
@Override
public String getHelp() {
return "Generates a scala-akka-http server (beta).";
}
public ScalaAkkaHttpServerCodegen() {
super();
modifyFeatureSet(features -> features
.includeDocumentationFeatures(DocumentationFeature.Readme)
.wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.XML, WireFormatFeature.Custom))
.securityFeatures(EnumSet.of(
SecurityFeature.BasicAuth,
SecurityFeature.ApiKey,
SecurityFeature.BearerToken
))
.excludeGlobalFeatures(
GlobalFeature.XMLStructureDefinitions,
GlobalFeature.Callbacks,
GlobalFeature.LinkObjects,
GlobalFeature.ParameterStyling
)
.excludeSchemaSupportFeatures(
SchemaSupportFeature.Polymorphism
)
.excludeParameterFeatures(
ParameterFeature.Cookie
)
);
generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
.stability(Stability.BETA)
.build();
outputFolder = "generated-code" + File.separator + "scala-akka-http";
modelTemplateFiles.put("model.mustache", ".scala");
apiTemplateFiles.put("api.mustache", ".scala");
embeddedTemplateDir = templateDir = "scala-akka-http-server";
groupId = "org.openapitools";
artifactId = "openapi-scala-akka-http-server";
artifactVersion = "1.0.0";
apiPackage = "org.openapitools.server.api";
modelPackage = "org.openapitools.server.model";
invokerPackage = "org.openapitools.server";
akkaHttpVersion = DEFAULT_AKKA_HTTP_VERSION;
generateAsManagedSources = DEFAULT_GENERATE_AS_MANAGED_SOURCES;
useApachePekko = DEFAULT_USE_APACHE_PEKKO;
setReservedWordsLowerCase(
Arrays.asList(
"abstract", "case", "catch", "class", "def", "do", "else", "extends",
"false", "final", "finally", "for", "forSome", "if", "implicit",
"import", "lazy", "match", "new", "null", "object", "override", "package",
"private", "protected", "return", "sealed", "super", "this", "throw",
"trait", "try", "true", "type", "val", "var", "while", "with", "yield")
);
cliOptions.add(CliOption.newString(CodegenConstants.INVOKER_PACKAGE, CodegenConstants.INVOKER_PACKAGE_DESC).defaultValue(invokerPackage));
cliOptions.add(CliOption.newString(CodegenConstants.GROUP_ID, CodegenConstants.GROUP_ID_DESC).defaultValue(groupId));
cliOptions.add(CliOption.newString(CodegenConstants.ARTIFACT_ID, CodegenConstants.ARTIFACT_ID).defaultValue(artifactId));
cliOptions.add(CliOption.newString(CodegenConstants.ARTIFACT_VERSION, "artifact version in generated pom.xml. This also becomes part of the generated library's filename").defaultValue(artifactVersion));
cliOptions.add(CliOption.newString(AKKA_HTTP_VERSION, AKKA_HTTP_VERSION_DESC).defaultValue(akkaHttpVersion));
cliOptions.add(CliOption.newBoolean(GENERATE_AS_MANAGED_SOURCES, GENERATE_AS_MANAGED_SOURCES_DESC).defaultValue(Boolean.valueOf(DEFAULT_GENERATE_AS_MANAGED_SOURCES).toString()));
cliOptions.add(CliOption.newBoolean(USE_APACHE_PEKKO, USE_APACHE_PEKKO_DESC).defaultValue(Boolean.valueOf(DEFAULT_USE_APACHE_PEKKO).toString()));
importMapping.remove("Seq");
importMapping.remove("List");
importMapping.remove("Set");
importMapping.remove("Map");
typeMapping = new HashMap<>();
typeMapping.put("array", "Seq");
typeMapping.put("set", "Set");
typeMapping.put("boolean", "Boolean");
typeMapping.put("string", "String");
typeMapping.put("int", "Int");
typeMapping.put("integer", "Int");
typeMapping.put("long", "Long");
typeMapping.put("float", "Float");
typeMapping.put("byte", "Byte");
typeMapping.put("short", "Short");
typeMapping.put("char", "Char");
typeMapping.put("double", "Double");
typeMapping.put("object", "Any");
typeMapping.put("file", "File");
typeMapping.put("binary", "File");
typeMapping.put("number", "Double");
typeMapping.put("decimal", "BigDecimal");
instantiationTypes.put("array", "ListBuffer");
instantiationTypes.put("map", "Map");
}
@Override
public void processOpts() {
super.processOpts();
if (additionalProperties.containsKey(CodegenConstants.INVOKER_PACKAGE)) {
invokerPackage = (String) additionalProperties.get(CodegenConstants.INVOKER_PACKAGE);
} else {
additionalProperties.put(CodegenConstants.INVOKER_PACKAGE, invokerPackage);
}
if (additionalProperties.containsKey(CodegenConstants.GROUP_ID)) {
groupId = (String) additionalProperties.get(CodegenConstants.GROUP_ID);
} else {
additionalProperties.put(CodegenConstants.GROUP_ID, groupId);
}
if (additionalProperties.containsKey(CodegenConstants.ARTIFACT_ID)) {
artifactId = (String) additionalProperties.get(CodegenConstants.ARTIFACT_ID);
} else {
additionalProperties.put(CodegenConstants.ARTIFACT_ID, artifactId);
}
if (additionalProperties.containsKey(CodegenConstants.ARTIFACT_VERSION)) {
artifactVersion = (String) additionalProperties.get(CodegenConstants.ARTIFACT_VERSION);
} else {
additionalProperties.put(CodegenConstants.ARTIFACT_VERSION, artifactVersion);
}
if (additionalProperties.containsKey(USE_APACHE_PEKKO)) {
useApachePekko = Boolean.parseBoolean(additionalProperties.get(USE_APACHE_PEKKO).toString());
} else {
additionalProperties.put(USE_APACHE_PEKKO, useApachePekko);
}
if (additionalProperties.containsKey(AKKA_HTTP_VERSION)) {
akkaHttpVersion = (String) additionalProperties.get(AKKA_HTTP_VERSION);
} else {
String version = useApachePekko ? DEFAULT_PEKKO_HTTP_VERSION : DEFAULT_AKKA_HTTP_VERSION;
additionalProperties.put(AKKA_HTTP_VERSION, version);
}
if (useApachePekko) {
additionalProperties.put(IS_10_1_10_PLUS, true); // Pekko HTTP is a fork of Akka HTTP 10.2.x
additionalProperties.put(USE_APACHE_PEKKO, true);
additionalProperties.put(AKKA_IMPORT_GROUP_ID, "org.apache.pekko");
} else {
additionalProperties.put(AKKA_IMPORT_GROUP_ID, "akka");
parseAkkaHttpVersion();
}
if (additionalProperties.containsKey(GENERATE_AS_MANAGED_SOURCES)) {
generateAsManagedSources = Boolean.parseBoolean(additionalProperties.get(GENERATE_AS_MANAGED_SOURCES).toString());
} else {
additionalProperties.put(GENERATE_AS_MANAGED_SOURCES, Boolean.valueOf(generateAsManagedSources).toString());
}
if (!generateAsManagedSources) {
supportingFiles.add(new SupportingFile("build.sbt.mustache", "", "build.sbt"));
supportingFiles.add(new SupportingFile("controller.mustache",
(sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "Controller.scala"));
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
}
supportingFiles.add(new SupportingFile("helper.mustache",
(sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "AkkaHttpHelper.scala"));
supportingFiles.add(new SupportingFile("stringDirectives.mustache",
(sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "StringDirectives.scala"));
supportingFiles.add(new SupportingFile("multipartDirectives.mustache",
(sourceFolder + File.separator + invokerPackage).replace(".", java.io.File.separator), "MultipartDirectives.scala"));
}
private void parseAkkaHttpVersion() {
boolean is10_1_10AndAbove = false;
Matcher matcher = akkaVersionPattern.matcher(akkaHttpVersion);
if (matcher.matches()) {
String majorS = matcher.group(1);
String minorS = matcher.group(3);
String patchS = matcher.group(5);
boolean andAbove = matcher.group(6) != null;
int major = -1, minor = -1, patch = -1;
try {
if (majorS != null) {
major = Integer.parseInt(majorS);
if (minorS != null) {
minor = Integer.parseInt(minorS);
if (patchS != null) {
patch = Integer.parseInt(patchS);
}
}
}
if (major > 10 || major == -1 && andAbove) {
is10_1_10AndAbove = true;
} else if (major == 10) {
if (minor > 1 || minor == -1 && andAbove) {
is10_1_10AndAbove = true;
} else if (minor == 1) {
if (patch >= 10 || patch == -1 && andAbove) {
is10_1_10AndAbove = true;
}
}
}
} catch (NumberFormatException e) {
LOGGER.warn("Unable to parse {}: {}, fallback to {}", AKKA_HTTP_VERSION, akkaHttpVersion, DEFAULT_AKKA_HTTP_VERSION);
akkaHttpVersion = DEFAULT_AKKA_HTTP_VERSION;
is10_1_10AndAbove = true;
}
}
additionalProperties.put(IS_10_1_10_PLUS, is10_1_10AndAbove);
}
@Override
public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List servers) {
CodegenOperation codegenOperation = super.fromOperation(path, httpMethod, operation, servers);
addPathMatcher(codegenOperation);
return codegenOperation;
}
@Override
public CodegenParameter fromParameter(Parameter parameter, Set imports) {
CodegenParameter param = super.fromParameter(parameter, imports);
if (primitiveParamTypes.contains(param.dataType)) {
if (!param.required) {
param.vendorExtensions.put("x-has-default-value", param.defaultValue != null);
// Escaping default string values
if (param.defaultValue != null && "String".equals(param.dataType)) {
param.defaultValue = String.format(Locale.ROOT, "\"%s\"", param.defaultValue);
}
}
} else {
// Removing unhandled types
param.dataType = "String";
}
return param;
}
@Override
public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List allModels) {
OperationsMap baseObjs = super.postProcessOperationsWithModels(objs, allModels);
pathMatcherPatternsPostProcessor(baseObjs);
marshallingPostProcessor(baseObjs);
return baseObjs;
}
private static final Set primitiveParamTypes = ImmutableSet.of(
"Int",
"Long",
"Float",
"Double",
"Boolean",
"String"
);
private static final Map pathTypeToMatcher = ImmutableMap.builder()
.put("Int", "IntNumber")
.put("Long", "LongNumber")
.put("Float", "FloatNumber")
.put("Double", "DoubleNumber")
.put("Boolean", "Boolean")
.put("String", "Segment")
.build();
protected void addPathMatcher(CodegenOperation codegenOperation) {
LinkedList allPaths = new LinkedList<>(Arrays.asList(codegenOperation.path.split("/")));
allPaths.removeIf(""::equals);
LinkedList pathMatchers = new LinkedList<>();
for (String path : allPaths) {
TextOrMatcher textOrMatcher = new TextOrMatcher("", true);
if (path.startsWith("{") && path.endsWith("}")) {
String parameterName = path.substring(1, path.length() - 1);
for (CodegenParameter pathParam : codegenOperation.pathParams) {
if (pathParam.baseName.equals(parameterName)) {
String matcher = pathTypeToMatcher.get(pathParam.dataType);
if (matcher == null) {
LOGGER.warn(
"The path parameter {} with the datatype {} could not be translated to a corresponding path matcher of akka http and therefore has been translated to string.",
pathParam.baseName, pathParam.dataType);
matcher = pathTypeToMatcher.get("String");
}
if (pathParam.pattern != null && !pathParam.pattern.isEmpty()) {
matcher = pathMatcherPatternName(pathParam);
}
textOrMatcher.value = matcher;
textOrMatcher.isText = false;
pathMatchers.add(textOrMatcher);
}
}
} else {
textOrMatcher.value = path;
textOrMatcher.isText = true;
pathMatchers.add(textOrMatcher);
}
}
codegenOperation.vendorExtensions.put("x-paths", pathMatchers);
}
public static String PATH_MATCHER_PATTERNS_KEY = "pathMatcherPatterns";
private static void pathMatcherPatternsPostProcessor(OperationsMap objs) {
if (objs != null) {
HashMap patternMap = new HashMap<>();
OperationMap operations = objs.getOperations();
if (operations != null) {
List ops = operations.getOperation();
for (CodegenOperation operation : ops) {
for (CodegenParameter parameter : operation.pathParams) {
if (parameter.pattern != null && !parameter.pattern.isEmpty()) {
String name = pathMatcherPatternName(parameter);
if (!patternMap.containsKey(name)) {
patternMap.put(name, new PathMatcherPattern(name, parameter.pattern.substring(1, parameter.pattern.length() - 1)));
}
}
}
}
}
objs.put(PATH_MATCHER_PATTERNS_KEY, new ArrayList<>(patternMap.values()));
}
}
private static String pathMatcherPatternName(CodegenParameter parameter) {
return parameter.paramName + "Pattern";
}
// Responsible for setting up Marshallers/Unmarshallers
public static void marshallingPostProcessor(OperationsMap objs) {
if (objs == null) {
return;
}
Set entityUnmarshallerTypes = new HashSet<>();
Set entityMarshallerTypes = new HashSet<>();
Set stringUnmarshallerTypes = new HashSet<>();
boolean hasCookieParams = false;
boolean hasMultipart = false;
OperationMap operations = objs.getOperations();
if (operations != null) {
List operationList = operations.getOperation();
for (CodegenOperation op : operationList) {
boolean isMultipart = op.isMultipart;
hasMultipart |= isMultipart;
hasCookieParams |= op.getHasCookieParams();
ArrayList fileParams = new ArrayList<>();
ArrayList nonFileParams = new ArrayList<>();
for (CodegenParameter parameter : op.allParams) {
if (parameter.isBodyParam || parameter.isFormParam) {
if (parameter.isFile) {
fileParams.add(parameter.copy());
} else {
nonFileParams.add(parameter.copy());
}
if (!parameter.isPrimitiveType) {
if (isMultipart) {
stringUnmarshallerTypes.add(new Marshaller(parameter));
} else {
entityUnmarshallerTypes.add(new Marshaller(parameter));
}
}
}
}
HashSet operationSpecificMarshallers = new HashSet<>();
for (CodegenResponse response : op.responses) {
if (!response.primitiveType) {
Marshaller marshaller = new Marshaller(response);
entityMarshallerTypes.add(marshaller);
operationSpecificMarshallers.add(marshaller);
}
response.vendorExtensions.put("x-empty-response", response.baseType == null && response.message == null);
response.vendorExtensions.put("x-is-default", "0".equals(response.code));
}
op.vendorExtensions.put("x-specific-marshallers", operationSpecificMarshallers);
op.vendorExtensions.put("x-file-params", fileParams);
op.vendorExtensions.put("x-non-file-params", nonFileParams);
}
}
objs.put("hasCookieParams", hasCookieParams);
objs.put("entityMarshallers", entityMarshallerTypes);
objs.put("entityUnmarshallers", entityUnmarshallerTypes);
objs.put("stringUnmarshallers", stringUnmarshallerTypes);
objs.put("hasMarshalling", !entityMarshallerTypes.isEmpty() || !entityUnmarshallerTypes.isEmpty() || !stringUnmarshallerTypes.isEmpty());
objs.put("hasMultipart", hasMultipart);
}
}
class Marshaller {
String varName;
String dataType;
public Marshaller(CodegenResponse response) {
if (response.containerType != null) {
this.varName = response.baseType + response.containerType;
} else {
this.varName = response.baseType;
}
this.dataType = response.dataType;
}
public Marshaller(CodegenParameter parameter) {
if (parameter.isArray) {
this.varName = parameter.baseType + "List";
} else if (parameter.isMap) {
this.varName = parameter.baseType + "Map";
} else if (parameter.isContainer) {
this.varName = parameter.baseType + "Container";
} else {
this.varName = parameter.baseType;
}
this.dataType = parameter.dataType;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Marshaller that = (Marshaller) o;
return varName.equals(that.varName) &&
dataType.equals(that.dataType);
}
@Override
public int hashCode() {
return Objects.hash(varName, dataType);
}
}
class PathMatcherPattern {
String pathMatcherVarName;
String pattern;
public PathMatcherPattern(String pathMatcherVarName, String pattern) {
this.pathMatcherVarName = pathMatcherVarName;
this.pattern = pattern;
}
}
class TextOrMatcher {
String value;
boolean isText;
public TextOrMatcher(String value, boolean isText) {
this.value = value;
this.isText = isText;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
TextOrMatcher that = (TextOrMatcher) o;
return isText == that.isText &&
value.equals(that.value);
}
@Override
public int hashCode() {
return Objects.hash(value, isText);
}
}
