编辑(swagger-edit)

安装

一：安装node.js

二：安装http-server

1
npm install -g http-server

三：下载 swagger-edit

1
git clone https://github.com/swagger-api/swagger-editor.git

四：运行

1
2
cd path/to/swagger-edit #就是进入到刚刚克隆的swagger-edit文件夹下
http-servers swagger-editor

五：查看

1
2
默认运行在8080 port
在浏览器打开窗口 http://localhost:8080

显示部分(swagger-ui)

一： 安装：下载 swagger-ui

二：创建一个文件夹用于swagger项目，然后初始化到节点

1
2
cd path/to/swagger/project
npm init

三：

然后你可以检查这里有一个package.json；*(npm init后出现package.json很正常)*

复制dist文件(swagger-ui里面的)到swagger项目；*(就是上面的project)*

安装express模块：

1
npm install express

四：

有一个node_modules文件夹和一个package-lock.json

创建一个index.js在swagger项目下：

1
2
3
4
5
6
7
8
9
10
11
var express = require('express'); 

var app = express();  
app.use('/swagger', express.static('dist'));
app.get('/', function (req, res) {  
    res.send('Hello World!'); 
});  

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');  
});

五：测试

1
2
3
4
node index.js

http://127.0.0.1:3000/  #Hello World
http://127.0.0.1:3000/swagger/ #页面

自定义样式：

修改dist中的index.html(新版在swagger-initializer.js里面了)的url,可以指定到自定义的json
默认的url: “http://petstore.swagger.io/v2/swagger.json"
修改成 ./swagger.json 或http://localhost:8092/v2/doc

重点：

你可以下载json例子从swagger editor.

假如主机不是基于swagger url，则需要指定主机,修改swagger.json里面的host

1
host:****:**   //swagger.json

参考链接

swagger 部署(Mac )

Linux系列之安装Swagger UI教程