Swagger介面如何生成Html離線文件
阿新 • • 發佈：2021-03-31
A very simple tool that converts Swagger Api Document to Html File.
小記Swagger介面生成Html離線文件
## 由來
很多人用`swagger2markup`以及`asciidoctor-maven-plugin`外掛來生成html格式的文件。
由於`swagger2markup`依賴的asm庫版本較低, 且依賴較多, 容易與專案中依賴的核心庫衝突。
所以, 乾脆把Swagger介面文件轉為Html文件獨立出來, 做成一個小工具, 這樣就清爽乾淨多了！
## 使用
```sh
# 下載原始碼
git clone https://github.com/iflyendless/Swagger2Html.git
# 編譯打包
mvn clean package
# 使用target目錄下的jar包, 引數是swagger介面資料
java -jar Swagger2Html-1.0-SNAPSHOT-jar-with-dependencies.jar http://localhost:8080/v2/api-docs
```
當前目錄下便會新增`api.html`檔案，用瀏覽器開啟效果如下圖：
看起來是不是有模有樣的! 建議正在使用swagger的朋友可以感受一下生成的離線Html。
## 實現
完整原始碼見：[https://github.com/iflyendless/Swagger2Html](https://github.com/iflyendless/Swagger2Html)
引入依賴：
```xml
io.github.swagger2markup
swagger2markup
1.3.3
org.asciidoctor
asciidoctorj
2.4.3
```
程式碼實現：
```java
import io.github.swagger2markup.GroupBy;
import io.github.swagger2markup.Language;
import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;
import org.asciidoctor.Asciidoctor;
import org.asciidoctor.AttributesBuilder;
import org.asciidoctor.OptionsBuilder;
import org.asciidoctor.SafeMode;
import java.io.File;
import java.net.URL;
import java.nio.file.Paths;
/**
* Swagger介面文件轉為html文件
*/
public class Swagger2Html {
private static final String DEFAULT_SWAGGER_API = "http://localhost:8080/v2/api-docs";
private static final String DEFAULT_ADOC_PATH = "./api.adoc";
private static final String DEFAULT_HTML_PATH = "./api.html";
public static void main(String[] args) throws Exception {
String swaggerApi = args.length >