本地啓動Swagger-ui查看Swagger導出的Json文件

當我們獲取項目中其他小夥伴給出的Swagger導出的API定義Json文件時,本地缺少查看環境直接使用文本編輯器打開是一件十分痛苦的事情。在這裏我將帶你用git, node和npm帶你快速搭建本地服務,查看swagger導出的j son文件。

依賴

git - 任何版本的git都可以,用於從github拉取最新的swagger-ui程式

Npm - 6.x 以上版本

使用官方推薦列表中的node.js版本會更具有穩定性。

安裝

這裏我更推薦使用homebrew去安裝git與node, npm。

  1. 首先,我們需要安裝homebrew,通過官方網站提供的安裝方式:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

或者通過mac自帶的ruby:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

或者指定ruby路徑:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

來實現homebrew的安裝。

  1. 接下來可以通過homebrew安裝git:
brew update
brew install git

成功安裝git後可以通過git --version命令查看git是否成功安裝。

  1. 通過homebrew安裝node和npm:
brew update
brew install node

成功安裝後可以通過node -vnpm -v來檢查是否成功安裝。

  1. 安裝swagger-ui並啓動

通過git拉取swagger-ui代碼並啓動項目:

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
npm run dev

稍後可以看到啓動成功的標示,並且打開http://localhost:3200/ 就能看到本地啓動的swagger-ui服務

  1. 安裝http-server並在swagger-ui中查看

我們看到在swagger-ui中查看的json原地址必須是在服務器中提供了web-server可以查看的json地址,爲了實現本地查看,需要在本地啓動web server。

這裏推薦直接使用http-server:

npm install --global http-server

接下來進入到需要查看的json文件的目錄中,假設我們要查看/path/Downloads/swagger.json文件,那麼執行:

cd /path/Downloads/
http-server --cors

這樣就可以在本地啓動http-server。

在Swagger-ui頁面中輸入:http://localhost:8080/swagger.json 便可以查看我們需要的swagger文件。
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章