By

环境搭建

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

git clone https://github.com/swagger-api/swagger-ui.git

安装 express
创建一个空文件夹node_app

 
    mkdir node_app

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

 
    cd node_ap
    npm init
    // 下面的看你心情填写
    name: (node_app) node_app
    version: (1.0.0)
    description:
    entry point: (index.js)
    test command:
    git repository:
    keywords:
    author:
    license: (ISC)

安装 express

    npm install express --save

创建 index.js

    vim index.js

把下面代码贴如 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 中创建空目录 public

      mkdir public
      cd public

修改路由

    vim ../index.js
    //在文件第三行插入下面这句话
    app.use('/static', express.static('public'));

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

开启 node

    node index.js

打开浏览器，输入http://localhost:3000/static/index.html

到此为止，你已经把官方的 demo 在本地配置好了。当然你也可以吧这个搭建在服务器上

编写文档并发布

使用Swagger Editor编写 API 文档

Swagger Editor 上的是基于 yaml 的语法，但是不用害怕，看着官方的 demo 看个10分钟就会了。

导出 test.json 文档

把 test.json 放到 node_app/public 目录下。
利用编辑器修改 index.html文件

url = “http://petstore.swagger.io/v2/swagger.json”;
为
url = “/static/test.json”;

重启 node 服务，浏览器中打开http://localhost:3000/static/index.html就是你自己写的 api 文档了