swagger本地環境搭建


參考文檔(Linux-Centos7.4 X64)

1、https://testerhome.com/topics/8168

2、https://testerhome.com/topics/9427

3.https://yq.aliyun.com/articles/773

操作步驟

步驟一、安裝nodejs

1.官網下載對應版本的nodejs

2.加壓tar -xvf node-v8.9.4-linux-x64.tar.xz

3.mv  node-v8.9.4-linux-x64 nodejs

4.cd /opt/nodejs/bin

5 ln -s /opt/nodejs/bin/node /usr/local/bin/node

ln -s /opt/nodejs/bin/npm /usr/local/bin/npm

6.npm -v /node -v 

步驟二、下載swagger-ui和swagger-edit

下載地址:https://github.com/swagger-api/swagger-ui

https://github.com/swagger-api/swagger-editor

步驟三、 安裝http-server

使用node.js安裝http-server模塊,主要通過http-server模塊來啟用http服務,運行swagger-editor,通過命令:npm install -g http-server

不過由於某些原因,國內安裝可能會非常慢,這時候我們就可以用淘寶 NPM 鏡像,來加速 

首先運行命令:npm install -g cnpm --registry=https://registry.npm.taobao.org

然后可能需要重啟cmd命令工具,運行:cnpm install -g http-server

這樣就能很快的安裝http-server了,同樣的道理,如果需要安裝其他模塊,也可以通過cnpm來安裝,然后通過cmd命令進入到Swagger-edit的根目錄,運行命令

http-server -p 8000 

-p的作用是指定端口,后面的8000就是我們指定的端口,訪問localhost:8000就可以進入swagger-edit就可以進入編輯界面了,左邊是編輯框,右邊是預覽界面

 

 步驟三(通過tomcat運行swagger-editor):tomcat運行swagger-editor

首先把swagger-editor目錄復制到tomcat根目錄的webapps,然后運行tomcat,訪問localhost:8080/swagger-editor

步驟四、部署swagger-ui

1. 創建一個空文件夾mkdir swagger

2.cd swagger,創建package.json文件:命令 touch package.json 

3.執行命令npm init:npm init package.json

4.安裝express: npm install express --save

5.在swagger中創建目錄public,並將剛才clone下來的Swagger UI中dist目錄下的所有文件全部復制到public目錄下面

6.創建並修改在swagger根目錄下:創建index.js,touch index.js,內容如下:

var express = require('express');
var http = require('http');
var app = express(); // 接口顯示頁面 app.use('/static', express.static('public')); app.listen(8005, function () { console.log('app listening on port 8005!'); });

7. 啟動服務,執行如下命令:cd swagger/

  node swagger.js

打開http://127.0.0.1:8005/static/index.html,可以看到在線的官方的Demo已經在本地搭建好了。

 

步驟五、優化改造swagger-UI--配置json文件

將導出的data.json放置在swagger/public/data/下,並且修改一下swagger/public/index.html

重啟node swagger.js,然后重新打開瀏覽器,可以看到自己根據服務端API編寫的API文檔

關鍵:如果想要自動生成接口測試用例,需要開發進行代碼開發編寫相關的注解


免責聲明!

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



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