Swagger UI搭配Nodejs使用 - 让API更直观

项目开发中前后端交互比较多，其中最重要的就是接口的交接，常用的接口交接方式就是用的Excel、doc，接口查看不是特别直观和美观，今天介绍一个可以在web界面显示API的方式。

Swagger是一个REST APIs文档在线自动生成和测试的框架，默认已经有nodejs环境。

1、创建node-swagger目录并安装express

选择一个合适目录执行以下命令

npm init执行后根据提示选择合适的输入，然后在执行以下命令安装express

2、创建public目录

目录结构

3、添加swagger官方demo

1. 下载swagger相关文件。
   可以利用git clone https://github.com/swagger-api/swagger-ui.git但是文件数太多，下载慢，我是在github下zip文件。
   
2. 解压后将dist目录下的文件全部拷贝到步骤2中的/public下。
   

4、编写nodejs脚本，启动swaggerUI

在/node-swagger新建index.js文件，内容如下：

const path = require('path');
const express = require('express');
const app = express();

app.use('/static', express.static(path.join(__dirname, 'public')));
app.listen(3000, () => console.log('hello~'));

node index.js启动项目，访问浏览器输入http://localhost:3000/static/index.html即可查看相关效果。