目錄

前言

在一些介面專案中，API的使用很頻繁，所以一款API線上文件生成和測試工具非常有必要。而Swagger UI就是這麼一款很實用的線上工具
本部落格介紹如何在公司或者自己的電腦上按照Swagger UI，注意因為公司的測試伺服器是Linux系統的，所以本部落格也只介紹基於Linux系統的Swagger環境搭建過程

伺服器環境安裝

NodeJS下載部署

首先需要下載NodeJS，到nodejs官網http://nodejs.org/dist/v0.10.26，下載node-v0.10.26-linux-x64.tar.gz，因為這個是已經編譯好的，所以我們先使用軟體將檔案上傳到Linux伺服器，可以使用WinSCP
然後用Linux的cd命令進入到你nodejs壓縮檔案的位置
解壓命令如下：

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

然後進入檔案

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

執行

./node

設定node全域性

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

設定npm全域性

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

檢測nodejs和npm是否安裝成功

node -v
npm -v

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

express下載部署

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

npm install express --save

以下幾個重要的模組是需要與 express 框架一起安裝的：
body-parser - node.js 中介軟體，用於處理 JSON, Raw, Text 和 URL 編碼的資料。
cookie-parser - 這就是一個解析Cookie的工具。通過req.cookies可以取到傳過來的cookie，並把它們轉成物件。
multer - node.js 中介軟體，用於處理 enctype=”multipart/form-data”（設定表單的MIME編碼）的表單資料。

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

檢測是否安裝成功

npm list express

NodeJS開機啟動

然後設定NodeJS開機啟動
安裝forever

npm install forever -g

設定

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

Swagger UI安裝部署

之後可以根據公司需要，在Linux上mkdir，我是先在root路徑，建立一個node_app檔案

mkdir node_app

進入node_app

cd node_app

環境配置

npm init

下面的提示可以根據自己需要填寫

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

VI編輯器使用：

vim index.js

加入程式碼

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("應用例項，訪問地址為 http://%s:%s", host, port)

})

啟用伺服器

node index.js

訪問，輸入http://公司伺服器IP:3000
可以看到Helloworld，當然我們是要部署Swagger
在node_app下面建立一個public資料夾

mkdir public
cd public

然後將下載到的swagger ui裡的dist資料夾裡的檔案複製到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)

})

Swagger Editor使用

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

Http server安裝

npm install -g http-server

啟動該專案http-server swagger-editor，預設為8080埠
設定port並啟動swagger editor

http-server –p 2017 swagger-editor

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