Share-API 更好用的 Swagger 文檔視圖工具

Swagger 是個很是強大的工具，將生成文檔的成本降到很低。

可是 SwaggerUI 部分界面和交互就有些難用了。

例如目前版本查看每一級模型是要一層層點開的。

特別是前端大部分無需關注後端模型的狀況下，可能一目瞭然的觀察接口總體 response 是個更好的選擇。

因而基於以上場景寫了一個 Swagger 的 UI 解析工具，只兼容 openapi 2.0 規範

項目地址： github.com/ShuangRen/s…

工具界面：

功能與特性：

1. 按照 Tag 分類，左側展現當前項目的全部 tags
2. 支持搜索，目前支持全項目搜索，不僅僅是當前項目
3. 支持多項目配置
4. 支持項目的公開和私有的配置
5. 支持配置 ip 白名單，白名單的 ip 地址能夠直接訪問私有配置
6. 支持 私有配置的密碼修改，默認 123456
7. enum 以一個更加友好的方式展現

快速開始

1. npm 安裝

npm i @shuangren/share-api
yarn add @shuangren/share-api複製代碼

2. 建立 index.js 文件

// index.js
const ApiDoc = require('@shuangren/share-api');
const doc = new ApiDoc();
doc.start();複製代碼

3. 啓動

node index.js複製代碼

默認啓動在 8081 端口

擴展配置

經過 config 設置快速配置項

1. dataPath後臺配置接口列表的存儲文件路徑 , 默認路徑爲dist/server
2. password訪問私有項目的密碼, 默認爲123456
3. port默認啓動端口爲 8081
4. ipList直接訪問私有項目的IP白名單列表, 默認爲[]

完整配置示例

const ApiDoc = require('@shuangren/share-api');
const doc = new ApiDoc();
doc.config({
  port: '3001',
  password: 'abc123',
  dataPath: '/var/demo/data.config'
  ipList:[
    '192.168.1.111',
    '21.221.1.111'
  ]
});
doc.start();複製代碼

某些狀況下對 Swagger.json 的解析可能會崩潰，若發現此問題請 Issue 告知