All Downloads are FREE. Search and download functionalities are using the official Maven repository.
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.
com.github.wu191287278.maven.swagger.doc.SwaggerDocs Maven / Gradle / Ivy
package com.github.wu191287278.maven.swagger.doc;
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.Paths;
import java.util.*;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.javaparser.ParseResult;
import com.github.javaparser.ParserConfiguration;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.symbolsolver.JavaSymbolSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.CombinedTypeSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.JarTypeSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.JavaParserTypeSolver;
import com.github.javaparser.symbolsolver.resolution.typesolvers.ReflectionTypeSolver;
import com.github.javaparser.utils.SourceRoot;
import com.github.wu191287278.maven.swagger.doc.visitor.JavaxRsVisitorAdapter;
import com.github.wu191287278.maven.swagger.doc.visitor.RestVisitorAdapter;
import io.swagger.models.*;
import io.swagger.models.auth.ApiKeyAuthDefinition;
import io.swagger.models.auth.In;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author yu.wu
*/
public class SwaggerDocs {
private Logger log = LoggerFactory.getLogger(SwaggerDocs.class);
private final ObjectMapper objectMapper = new ObjectMapper()
.setSerializationInclusion(JsonInclude.Include.NON_NULL);
private String title = "Api Documentation";
private String description = "";
private String version = "1.0.0";
private String basePath = "/";
private String host = "localhost";
private Boolean camel = true;
public SwaggerDocs() {
}
public SwaggerDocs(String title, String description, String version, String basePath, String host) {
this.title = title;
this.description = description;
this.version = version;
this.basePath = basePath;
this.host = host;
}
public void writeUI(String path) {
File file = new File(path);
if (file.exists()) return;
try {
try (InputStream in = SwaggerDocs.class.getClassLoader().getResourceAsStream("static/swagger-ui.html");
OutputStream out = new BufferedOutputStream(new FileOutputStream(file))) {
if (in == null) return;
IOUtils.copy(in, out);
}
} catch (IOException ignore) {
}
}
public void writeTo(String path, Swagger swagger) {
File file = new File(path);
if (!file.getParentFile().exists()) {
file.getParentFile().mkdirs();
}
try (BufferedWriter out = new BufferedWriter(new FileWriter(file))) {
String json = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(swagger);
out.write(json);
out.flush();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public Map parse(String sourceDirectory, String basePackage, List libraries, Consumer consumer) {
log.info("Parsing " + sourceDirectory);
List filteredDirectories = getSourceDirectories(sourceDirectory, basePackage);
List sourceDirectories = getSourceDirectories(sourceDirectory, basePackage);
Map swaggerMap = new TreeMap<>();
for (File filteredDirectory : filteredDirectories) {
String projectPath = filteredDirectory.getAbsolutePath().replace("src/main/java", "")
.replace("src\\main\\java", "");
CombinedTypeSolver typeSolver = new CombinedTypeSolver();
for (File sourceFile : sourceDirectories) {
typeSolver.add(new JavaParserTypeSolver(sourceFile));
}
try {
typeSolver.add(new ReflectionTypeSolver(false));
JarTypeSolver jarTypeSolver = null;
for (String library : libraries) {
jarTypeSolver = JarTypeSolver.getJarTypeSolver(library);
}
if (jarTypeSolver != null) {
typeSolver.add(jarTypeSolver);
}
} catch (Exception e) {
log.warn(e.getMessage());
}
final RestVisitorAdapter restVisitorAdapter = new RestVisitorAdapter(consumer)
.setCamel(camel);
final JavaxRsVisitorAdapter javaxRsVisitorAdapter = new JavaxRsVisitorAdapter();
Info info = new Info()
.title(this.title)
.description(this.description)
.version(this.version);
final Swagger swagger = new Swagger()
.info(info)
.paths(new TreeMap<>())
.schemes(Arrays.asList(Scheme.HTTP, Scheme.HTTPS))
.host(this.host)
.basePath(this.basePath)
.securityDefinition("api_key", new ApiKeyAuthDefinition("Authorization", In.HEADER));
ParserConfiguration parserConfiguration = new ParserConfiguration();
parserConfiguration.setSymbolResolver(new JavaSymbolSolver(typeSolver));
SourceRoot sourceRoot = new SourceRoot(Paths.get(filteredDirectory.getAbsolutePath()), parserConfiguration);
List> parseResults = sourceRoot.tryToParseParallelized();
for (ParseResult parseResult : parseResults) {
parseResult.ifSuccessful(r -> r.accept(javaxRsVisitorAdapter, swagger));
parseResult.ifSuccessful(r -> r.accept(restVisitorAdapter, swagger));
}
for (Map.Entry entry : javaxRsVisitorAdapter.getModelMap().entrySet()) {
swagger.model(entry.getKey(), entry.getValue());
}
for (Map.Entry entry : restVisitorAdapter.getModelMap().entrySet()) {
swagger.model(entry.getKey(), entry.getValue());
}
if (swagger.getPaths() != null && !swagger.getPaths().isEmpty()) {
String projectName = new File(projectPath).getName();
swagger.getInfo().title(title);
swagger.host(host);
swagger.basePath(basePath);
swaggerMap.put(projectName, swagger);
for (Path path : swagger.getPaths().values()) {
for (Operation operation : path.getOperations()) {
List tags = operation.getTags();
Map> security = Stream.of("api_key")
.collect(Collectors.toMap(s -> s, s -> new ArrayList<>()));
operation.setSecurity(Collections.singletonList(security));
}
}
}
if (swagger.getTags() != null) {
Map tagMap = swagger.getTags()
.stream()
.collect(Collectors.toMap(Tag::getName, t -> t));
swagger.tags(new ArrayList<>(new TreeMap<>(tagMap).values()));
}
}
return swaggerMap;
}
private List getSourceDirectories(String sourceDirectory, String basePackage) {
List files = new ArrayList<>();
filterSourceDirectory(sourceDirectory, basePackage == null ? "" : basePackage, files);
return files;
}
private void filterSourceDirectory(String sourceDirectory, String basePackage, List files) {
File parentDirectoryFile = new File(sourceDirectory);
if (!parentDirectoryFile.isDirectory()) return;
File sourceDirectoryFile = new File(sourceDirectory, "/src/main/java/" + basePackage.replace(".", "/"));
if (!sourceDirectoryFile.exists()) {
File[] listFiles = parentDirectoryFile.listFiles();
if (listFiles != null) {
for (File file : listFiles) {
filterSourceDirectory(file.getAbsolutePath(), basePackage, files);
}
}
} else {
files.add(sourceDirectoryFile);
}
File targetDirectoryFile = new File(sourceDirectory, "/target/generated-sources/annotations/" + basePackage.replace(".", "/"));
if (!targetDirectoryFile.exists()) {
File[] listFiles = targetDirectoryFile.listFiles();
if (listFiles != null) {
for (File file : listFiles) {
filterSourceDirectory(file.getAbsolutePath(), basePackage, files);
}
}
} else {
files.add(targetDirectoryFile);
}
}
public void setCamel(Boolean camel) {
this.camel = camel;
}
}
