久久久一二三区,日B影视库

在團(tuán)隊(duì)開發(fā)中，一個(gè)好的 API 文檔可以減少很多交流成本，也可以使一個(gè)新人快速上手業(yè)務(wù)。

前言

swagger ui是一個(gè)API在線文檔生成和測試的利器，目前發(fā)現(xiàn)最好用的。

為什么好用？Demo 傳送門

支持API自動(dòng)生成同步的在線文檔

這些文檔可用于項(xiàng)目內(nèi)部API審核

方便測試人員了解API

這些文檔可作為客戶產(chǎn)品文檔的一部分進(jìn)行發(fā)布

支持API規(guī)范生成代碼，生成的客戶端和服務(wù)器端骨架代碼可以加速開發(fā)和測試速度

總結(jié)一句話就是好用，逼格高。下面我將總結(jié)一下如何快速在本地搭建一個(gè)基于Node和Swagger UI的 API 的文檔工具

環(huán)境搭建

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

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

安裝 express

創(chuàng)建一個(gè)空文件夾node_app

mkdir node_app

初始化 node ，創(chuàng)建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

創(chuàng)建 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 中創(chuàng)建空目錄 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 目錄下的文件全部復(fù)制到 public 文件夾下。