From 2756bd59ffc34bce34323dd7079ee4107cf0453e Mon Sep 17 00:00:00 2001 From: qizai Date: Sun, 27 Jan 2019 15:43:31 +0800 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7b7f8b1..5aa9280 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ # swagger-to-html swagger可视化工具,用于指定的swagger url 生成可视化的单页面html + +## 依赖环境 +jdk8 + +## 使用方法 +``` +java -jar swagger-to-html.jar "此处是你swaggerAPI的json内容访问地址" +``` + +例如:java -jar swagger-to-html.jar "http://localhost:8080/v2/api-docs" + +生成完毕后将在运行目录下创建两个文件:apidoc.adoc和apidoc.html