Linux系列之安裝Swagger UI教程

目錄

文章目錄

目錄

前言

服務(wù)器環(huán)境安裝

Swagger UI安裝部署

Swagger Editor使用

前言

在一些接口項目中，API的使用很頻繁，所以一款A(yù)PI在線文檔生成和測試工具非常有必要。而Swagger UI就是這么一款很實用的在線工具

本博客介紹如何在公司或者自己的電腦上按照Swagger UI，注意因為公司的測試服務(wù)器是linux系統(tǒng)的，所以本博客也只介紹基于Linux系統(tǒng)的Swagger環(huán)境搭建過程

服務(wù)器環(huán)境安裝

###NodeJS下載部署###

首先需要下載NodeJS，到nodejs官網(wǎng)http://nodejs.org/dist/v0.10.26，下載node-v0.10.26-linux-x64.tar.gz，因為這個是已經(jīng)編譯好的，所以我們先使用軟件將文件上傳到Linux服務(wù)器，可以使用WinSCP

然后用Linux的cd命令進入到你nodejs壓縮文件的位置

解壓命令如下：

tar xvf node-v0.10.26-linux-x64.tar.gz

1

然后進入文件

cd node-v0.10.26-linux-x64/bin

1

執(zhí)行

./node

1

設(shè)置node全局

ln -s /root/Swagger/node-v0.10.26-linux-x64/bin/node /usr/local/bin/node

1

設(shè)置npm全局

ln -s /root/Swagger/node-v0.10.26-linux-x64/bin/npm /usr/local/bin/npm

1

檢測nodejs和npm是否安裝成功

node -v npm -v

1

2

可以看到版本號，什么安裝成功

###express下載部署####

安裝好NodeJS和NPM之后，我們就可以安裝express了

npm install express --save

1

以下幾個重要的模塊是需要與 express 框架一起安裝的：

body-parser - node.js 中間件，用于處理 JSON, Raw, Text 和 URL 編碼的數(shù)據(jù)。

cookie-parser - 這就是一個解析Cookie的工具。通過req.cookies可以取到傳過來的cookie，并把它們轉(zhuǎn)成對象。

multer - node.js 中間件，用于處理 enctype=“multipart/form-data”（設(shè)置表單的MIME編碼）的表單數(shù)據(jù)。

npm install body-parser --save npm install cookie-parser --save npm install multer --save

1

2

3

檢測是否安裝成功

npm list express

1

###NodeJS開機啟動####

然后設(shè)置NodeJS開機啟動

安裝forever

npm install forever -g

1

設(shè)置

forever start test.js forever stop test.js forever restart test.js

1

2

3

Swagger UI安裝部署

github上clone：https://github.com/swagger-api/swagger-ui

如果有下載Git，就是用git下載，獲取訪問github，直接下載

之后可以根據(jù)公司需要，在Linux上mkdir，我是先在root路徑，創(chuàng)建一個node_app文件

mkdir node_app

1

進入node_app

cd node_app

1

環(huán)境配置

npm init

1

下面的提示可以根據(jù)自己需要填寫

name: (node_app) node_app version: (1.0.0) description: entry point: (index.js) test command: git repository: keywords: author: license: (ISC)

1

2

3

4

5

6

7

8

9

VI編輯器使用：

vim index.js

1

加入代碼

var express = require('express'); var app = express(); app.get('/', function (req, res) { res.send('Hello World'); }) var server = app.listen(3000, function () { var host = server.address().address var port = server.address().port console.log("應(yīng)用實例，訪問地址為 http://%s:%s", host, port) })

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

啟用服務(wù)器

node index.js

1

訪問，輸入http://公司服務(wù)器IP:3000

可以看到Helloworld，當然我們是要部署Swagger

在node_app下面創(chuàng)建一個public文件夾

mkdir public cd public

1

2

然后將下載到的swagger ui里的dist文件夾里的文件復(fù)制到public文件夾里

修改index.js

var express = require('express'); var app = express(); app.use('/swagger',express.static('public')); app.get('/', function (req, res) { res.send('Hello World'); }) var server = app.listen(3000, function () { var host = server.address().address var port = server.address().port console.log("swagger start", host, port) })

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

然后輸入http://ip:3000/swapper，是可以看到類似page

Swagger Editor使用

Swagger Editor是Swagger UI的在線編輯器，我們可以自己搭建一個，也可以使用官方的，下面給出官方的URL:http://editor.swagger.io/#/

github上Clone：https://github.com/swagger-api/swagger-editor

之后將swagger editor文件放在公司Linux服務(wù)器上

###Http server安裝###

npm install -g http-server

1

啟動該項目http-server swagger-editor，默認為8080端口

設(shè)置port并啟動swagger editor

http-server –p 2017 swagger-editor

1

輸入http://ip:2017/#/可以訪問到自己搭建的Swagger Editor編輯器

參考教程

http://www.linuxidc.com/Linux/2014-07/104489.htm

http://www.linuxidc.com/Linux/2014-06/103372.htm

http://blog.csdn.net/ron03129596/article/details/53559803

http://www.open-open.com/lib/view/open1453452052745.html

Linux

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔相應(yīng)法律責任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。