Swagger UI教程 API 文档神器

目录

[TOC]

前言

在一些接口项目中,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安装部署##

github上clone:https://github.com/swagger-api/swagger-ui
如果有下载Git,就是用git下载,获取访问github,直接下载

之后可以根据公司需要,在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)
 
})

然后输入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服务器上

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编辑器

参考教程
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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容