Swagger UI教程 API 文档神器搭配Node使用

在团队开发中，一个好的 API 文档可以减少很多交流成本，也可以使一个新人快速上手业务。

前言

swagger ui是一个API在线文档生成和测试的利器，目前发现最好用的。

为什么好用？Demo 传送门

支持API自动生成同步的在线文档

这些文档可用于项目内部API审核

方便测试人员了解API

这些文档可作为客户产品文档的一部分进行发布

支持API规范生成代码，生成的客户端和服务器端骨架代码可以加速开发和测试速度

总结一句话就是好用，逼格高。下面我将总结一下如何快速在本地搭建一个基于Node和Swagger UI的 API 的文档工具

环境搭建

下载Swagger UI（也可以直接下载 zip 文件）

gitclonehttps://github.com/swagger-api/swagger-ui.git

安装 express

创建一个空文件夹node_app

mkdir node_app

初始化 node ，创建package.json文件（）

➜ ~ ✗ >cdnode_ap➜ ~/node_app ✗ >npm init// 下面的看你心情填写name: (node_app) node_appversion: (1.0.0)description:entry point: (index.js)testcommand:git repository:keywords:author:license: (ISC)

安装 express

➜ ~/node_app git:(master) ✗ >npm install express --save

创建 index.js

➜ ~/node_app git:(master) ✗ >vim index.js

把下面代码贴如 index.js 中

varexpress =require('express');varapp = express();app.get('/',function(req, res){ res.send('Hello World!');});app.listen(3000,function(){console.log('Example app listening on port 3000!');});

在 node_app 中创建空目录 public

➜ ~/node_app git:(master) ✗ >mkdirpublic➜ ~/node_app git:(master) ✗ >cdpublic

修改路由

➜ ~/node_app/publicgit:(master) ✗ >vim ../index.js//在文件第三行插入下面这句话app.use('/static', express.static('public'));

把下载好的Swagger UI 文件中dist 目录下的文件全部复制到 public 文件夹下。