centos 7 搭建 Swagger Editor + Swagger-UI

一、install Node.js and npm on CentOS 7

1. 通过 SSH 方式登录到你的 VPS

ssh user@vps_IP

2. Update the system and install necessary packages

yum install curl sudo

3. 从 NodeSource repository 安装 Node.js and npm

To enable the EPEL repository on your CentOS 7 VPS, issue the following command:

sudo yum install epel-release

添加 Node.js v8 LTS repository:

curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -

Once the NodeSource repository is enabled we can proceed with the Node.js v8 LTS and npm installation:

sudo yum install nodejs

4. Install build tools

To compile and install native addons from the npm repository we also need to install build tools:

sudo yum install gcc-c++ make

验证 Node.js 安装是否成功：

node -v 

验证 npm 安装是否成功：

npm -v

以上两个如果结果显示对应版本号，说明安装成功。否则，请重新安装。

二、安装 Swagger-Editor

在服务器上新建目录，我在公共机上以我的名字建了一个文件夹 changyou。

cd changyou

进入 changyou 目录，下载 swagger-editor 最新版本到这里。

下载完成，后解压

tar -xvf swagger-editor-3.6.6.tar

然后切换到根目录，开始安装 node.js HttpServer

npm install -g http-server

安装完成后，再次切换到 changyou 目录下，执行命令，启动服务：

http-server swagger-editor 以8080端口启动项目 
http-server –p 8082 swagger-editor 指定端口启动项目
http-server -p 8081 swagger-editor-3.6.6

这样就可以在浏览器访问 swagger-editor 了，如 http://127.0.0.1:8081/

三、安装 Swagger-UI

1. 进入 changyou 目录，下载并解压最新 Swagger-UI 包到这里。

cd changyou

2. 创建一个空文件夹 swagger , cd 到该目录下。

cd swagger

3. 初始化 node ，创建package.json文件（）

npm init

// 根据提示，自行填写
name: (node_app) node_app
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)

4. 安装 express

npm install express --save

这一步不要忘记了，开始我没有执行这个，后来怎么都安装不成功，白白浪费了好多时间。

5. 创建 index.js

vim index.js 

把下面代码贴如 index.js 中

var express = require('express');
var app = express();
var http = require('http');
app.use('/static', express.static('public'));
app.get('/', function (req, res) {
  res.send('Hello World!');
});

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');
});

此处注意 app.use('/static', express.static('public')); 是新添加的，需要根据这个定位项目路径。

6. 在 swagger 中创建空目录 public

把下载好的 Swagger UI 文件中 dist 目录下的全部文件复制到 public 文件夹下。
将 index.html 文件中的 javascript 代码的 url 修改为 /static/test.json

7. 生成 test.json

使用前面搭建好的 Swagger Editor 编辑一个 test.json 文件，并上传到 changyou/swagger/public ，这个用于下面的测试。

项目结构图

8. cd 到 changyou/swagger 目录,重启 node 服务器

node index.js

浏览器打开 http://127.0.0.1:3000/static/index.html

至此 Node.js +Swagger Editor + Swagger-UI 环境搭建完成，Perfect !

附：服务器后台启动进程

// 后台启动进程，退出命令行不取消进程
nohup http-server -p 8081 swagger-editor-3.6.6 & 

// 后台启动进程，退出命令行不取消进程
nohup http-server -p 8081 swagger-editor-3.6.6 & 

// 查询进程
ps aux|grep flume 

// 根据端口号查询进程
lsof -i:8081 

// 杀掉进程：
kill -9 xxxxx

// 安全退出命令行登录 
exit

参考：

1. how-to-install-node-js-and-npm-on-centos-7
2. Node.js +Swagger Editor + Swagger-UI 环境搭建
3. Swagger UI教程 API 文档神器 搭配Node使用