簡介
Swagger– The World's Most Popular Framework for APIs.
Swagger 是一款RESTFUL接口的文檔在線自動生成+功能測試功能軟件。本文主要介紹在項目開發(fā)前期Swagger本地環(huán)境的搭建湖饱，包括Swagger UI 和Swagger Editor薪前。
環(huán)境
Node.js： ? ? ? ? v7.6.0
Npm： ? ? ? ? ? ? ? ?4.1.2
依賴： Express唁情，http-server
Swagger UI
1渺杉、下載Swagger UI
git@github.com:swagger-api/swagger-ui.git
2悼泌、創(chuàng)建項目文件夾
mkdir myapp
3垛耳、初始化myapp
進入myapp目錄初始化
npm init
此時目錄下會生產(chǎn)package.json文件
4瓶珊、安裝Express
npm install express --save
5啸箫、創(chuàng)建index.js
寫入如下代碼：
var express = require('express');
var app = express();
app.get('/', function (req, res) {
res.send('Hello World!');
});
app.listen(3000, function () {
console.log('Example app listening on port 3000!');
});
6、在myapp目錄中創(chuàng)建public文件夾
修改第5步中的index.js文件伞芹，在文件第三行添加如下代碼：
app.use('/static', express.static('public'));
7忘苛、把下載好的Swagger UI 文件中dist 目錄下的文件全部復(fù)制到 public 文件夾下
8、啟動node
node index.js
9唱较、打開瀏覽器扎唾，輸入http://localhost:3000/static/index.html
Swagger Editor
1、下載Swagger Editor
git@github.com:swagger-api/swagger-editor.git
2南缓、安裝http-server
npm install http-server -g
3胸遇、啟動
http-server swagger-editor
默認為8080端口，如果要修改端口號汉形，使用如下命令：http-server –p 2008 swagger-editor
4纸镊、瀏覽器訪問
http://127.0.0.1:8080
到此，基本上本地環(huán)境搭建成功了概疆，使用Editor生成的文檔逗威，可以使用UI查看，主需要修改index.html文件中的url即可岔冀，如有疑問歡迎留言交流庵楷，謝謝！
