之前公司使用
Yapi(我的建議少办，哈哈)來管理API券躁，但是公司要求提供API文檔方便與其他項目組對接艾扮。好在Yapi提供到處html接口文檔。但是問題來了筐高，請看下面的html導(dǎo)出效果搜囱。
演示鏈接
總體還是可以的，雖然不是特別好看柑土，但是還是看的過去的蜀肘。不過我們項目要求要有搜索功能。為此要編寫一個導(dǎo)出工具稽屏，在導(dǎo)出時動態(tài)的改變html的到想要的效果了扮宠。本來這里應(yīng)該開發(fā)一個Yapi插件的，但是基于其他考慮诫欠，最后決定使用Java開發(fā)涵卵。
總體采用
jcommander解析命令行輸入?yún)?shù)浴栽。
okhttp3進(jìn)行網(wǎng)絡(luò)請求。
jsoup對html進(jìn)行處理轿偎。
gson對json進(jìn)行處理典鸡。
groovy自定義對導(dǎo)出的數(shù)據(jù)進(jìn)行處理。
項目結(jié)構(gòu)如下圖：
下面還是展示源代碼：
/**
* @description: yapi導(dǎo)出
* @author: zhanjinbing
* @data: 2020-01-19 09:42
*/
public class Main {
private static CommanderArgs commanderArgs = new CommanderArgs();
private static String scriptText;
private static GroovyObject groovyObject;
public static void main(String[] args) {
// 顯示版本信息
Optional<String> versionOpt = Arrays.asList(args).stream()
.filter(arg -> "-v".equals(arg) || "-version".equals(arg))
.findFirst();
if (versionOpt.isPresent()) {
System.out.println("當(dāng)前版本為：" + commanderArgs.getVersion());
return;
}
JCommander jCommander = JCommander.newBuilder().addObject(commanderArgs).build();
try {
jCommander.parse(args);
} catch (ParameterException e) {
System.out.println(e.getMessage());
jCommander.usage();
return;
}
System.out.println(
"╭╮╭╮╭━━╮╭━━╮╭━━╮ ┌──╮ ┐┐ ┐ ┌──┐ ╭─┌╯─╮\n" +
"┃╰╯┃┃╭╮┃┃╭╮┃╰╮╭╯┌┬──┬┐┌╯├─┼┘└╯╮ │ │││┌┐│\n" +
"╰╮╭╯┃╰╯┃┃╰╯┃ ┃┃ │ │ │││ │ ┌─┴─╯┐││││││\n" +
" ┃┃ ┃╭╮┃┃╭━╯ ┃┃ │ │ ││╯ │ ┌─┬──┐││││││\n" +
" ┃┃ ┃┃┃┃┃┃ ╭╯╰╮ └─┌╯ │──┼┘├─┼──┤││││││\n" +
" ╰╯ ╰╯╰╯╰╯ ╰━━╯└──╯─┘╰┘ ┘ ╰─┴──┘ ┘─╯┘╯\n");
// 開始運行導(dǎo)出方案
run();
}
private static void run() {
// 執(zhí)行登錄過程
YapiService yapiService = new YapiService(commanderArgs.getHost());
try {
yapiService.login(commanderArgs.getEmail(), commanderArgs.getPassword());
} catch (IOException e) {
e.printStackTrace();
System.out.println("登錄失敗");
return;
}
YapiProjectInfo yapiProjectInfo;
try {
String projectInfo = yapiService.getProjectInfo(commanderArgs.getPid());
JsonElement jsonElement = JsonParser.parseString(projectInfo);
JsonObject data = jsonElement.getAsJsonObject().get("data").getAsJsonObject();
Gson gson = new Gson();
yapiProjectInfo = gson.fromJson(data, YapiProjectInfo.class);
String msg = String.format("正在導(dǎo)出...《%s》中的%s", yapiProjectInfo.getName(), commanderArgs.getTypes());
System.out.println(msg);
} catch (IOException e) {
e.printStackTrace();
System.out.println("獲取項目信息失敗");
return;
}
if (commanderArgs.getScriptFile() != null) {
try {
scriptText = IOUtils.toString(new FileInputStream(commanderArgs.getScriptFile())
, Charset.defaultCharset());
} catch (IOException e) {
e.printStackTrace();
System.out.println("腳本文件文本讀取異常");
return;
}
GroovyClassLoader classLoader = new GroovyClassLoader();
Class groovyClass = classLoader.parseClass(scriptText);
try {
groovyObject = (GroovyObject) groovyClass.newInstance();
} catch (InstantiationException | IllegalAccessException e) {
e.printStackTrace();
System.out.println("生成java類發(fā)生異常");
}
}
// 導(dǎo)出指定類型的文件
for (String type : commanderArgs.getTypes()) {
String outputFilePath = String.format("%s%s%s.%s", System.getProperty("user.dir"),
File.separator, commanderArgs.getOutputFileName(), type);
File outFile = new File(outputFilePath);
if (outFile.exists() && !commanderArgs.isOverride()) {
System.out.println(String.format("[%s]文件已存在坏晦，跳過", outputFilePath));
continue;
}
try {
String exportStr;
if ("swagger".equalsIgnoreCase(type)) {
exportStr = yapiService.exportSwagger(commanderArgs.getPid(), commanderArgs.isWiki());
} else {
exportStr = yapiService.export(type, commanderArgs.getPid(), commanderArgs.isWiki());
}
// 判斷是否有腳本要處理文件
String outPutStr = (scriptText != null ? dealExportScript(type, exportStr) : exportStr);
// 檢查處理后的文本
if (outPutStr == null) {
System.out.println(String.format("[%s]處理后的文本為空萝玷，跳過", outputFilePath));
continue;
}
try (OutputStream outputStream = new FileOutputStream(outFile)) {
outputStream.write(outPutStr.getBytes(Charset.defaultCharset()));
outputStream.flush();
System.out.println(String.format("[%s]文件下載成功", outputFilePath));
} catch (IOException e) {
System.out.println(String.format("[%s]文件寫入失敗", outputFilePath));
throw e;
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
private static String dealExportScript(String type, String exportStr) {
String methodName = String.format("deal%s", type.toUpperCase());
String dealStr;
switch (type) {
case "swagger":
case "json":
JsonElement jsonElement = JsonParser.parseString(exportStr);
dealStr = invoke(methodName, exportStr, jsonElement);
break;
case "html":
Document doc = Jsoup.parse(exportStr);
dealStr = invoke(methodName, exportStr, doc);
break;
default:
dealStr = invoke(methodName, exportStr);
break;
}
return dealStr;
}
private static String invoke(String function, Object... objects) {
Optional<MetaMethod> method =
groovyObject.getMetaClass().getMethods().stream()
.filter(metaMethod -> metaMethod.getName().equals(function))
.findFirst();
return (String) (method.isPresent() ?
groovyObject.invokeMethod(function, objects) :
objects[0]);
}
}
這里我就只貼Main類中的代碼吧，減少篇幅昆婿。下面是github地址
https://github.com/zjbshk/yapi
下面是演示效果：
java -jar yapi-1.0-SNAPSHOT.jar -h [Yapi地址] -e [用戶名] -p [密碼] -pid [項目id] -o [文件名] -t json -t html -s [script.groovy,腳本路徑]
