在团队开发中,一个好的 API 文档可以减少很多交流成本,也可以使一个新人快速上手业务。
总结一句话就是好用,逼格高。下面我将总结一下如何快速在本地搭建一个基于Node和Swagger UI的 API 的文档工具
git clone https://github.com/swagger-api/swagger-ui.git
mkdir node_app
~ ? >cd node_ap? ~/node_app ? >npm init// 下面的看你心情填写name: (node_app) node_appversion: (1.0.0)description:entry point: (index.js)test command:git repository:keywords:author:license: (ISC)
~/node_app git:(master) ? >npm install express --save
~/node_app git:(master) ? >vim 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!');});
~/node_app git:(master) ? >mkdir public? ~/node_app git:(master) ? >cd public
~/node_app/public git:(master) ? >vim ../index.js//在文件第三行插入下面这句话app.use('/static', express.static('public'));
~/node_app git:(master) ? >node index.js
到此为止,你已经把官方的 demo 在本地配置好了。当然你也可以吧这个搭建在服务器上
url = "http://petstore.swagger.io/v2/swagger.json";
为url = "/static/test.json";
http://localhost:3000/static/index.html
就是你自己写的 api 文档了联系客服