swagger-ui生成api文檔並進行測試


一、Swagger UI簡介

Swagger UI是一個API在線文檔生成和測試的利器,目前發現最好用的。它的源碼也開源在GitHub上,地址:GitHub: https://github.com/swagger-api/swagger-ui

二、Swagger UI環境搭建

下載Swagger UI(也可以直接下載 zip 文件)

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

解壓好的文件

 

主要用到的是dist目錄,可以進入dist目錄打開index.html看下界面,可以發現基本的模式是有了,但都是靜態的文件。下面我們要進行nodejs配置,使其可以進行端口訪問,直接使用node命令訪問index.js沒有反應,英語稍微好點的同學可以看下官網的配置步驟,接下來手動配置ui環境。

下面進行項目的配置

新建node_app文件夾

mkdir node_app

進入node_app目錄,初始化node

npm init

根據提示輸入好信息后會自動創建package.json文件,如下圖:

 

初始化命令npm init,出現如下信息,填的地方可以隨便寫,也可以不寫

將下載的swagger-ui中的dist文件夾拷貝到node_app

安裝express

install express

創建index.js,並將如下代碼寫入該js

var express = require('express');

var app = express();

app.use('/root', express.static('dist'));

app.get('/', function (req, res) {

  res.send('Hello World!');

});

 

app.listen(3000, function () {

  console.log('Example app listening on port 3000!');

});

然后啟動,並運行查看,如上代碼為3000端口,如有沖突請自行修改

 

node index.js

 

 

訪問

 

你可能會疑惑:這個Uber API怎么來的呢?下面我再給您解釋下這個Uber API的來路,編輯index.html

文件你會發現有一段url引用了swagger官網的jsonApi文件

 

這里我們將這個json文件下載下來放到和index.html平級的目錄,這里我直接訪問我已經安裝好的swagger-edtior進行文件的下載

 

然后存放到如下目錄,並修改index.html

 

把index.html里的url換成swagger.json(注意這回寫的是相對路徑啦)

三、如何在tomcat里運行?

node_app文件夾(已共享到QQ群文件:301343109)整個拷到tomcatwebapp目錄下,然后啟動tomcat,訪問http://localhost:8070/node_app/dist/index.html,注意8070是我的tomcat的端口,因為我的8080端口已經運行了Swagger Editor

 

可以看到和在express里訪問的一樣。

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM