swagger的搭建和使用

swagger:方便测试人员和客户端开发了解API

1. 第一步搭建官方的swagger ui

1.1 下载

git clone https://github.com/swagger-api/swagger-ui.git

1.2 创建一个另外的文件夹--用来发布

mkdir swagger

1.3 在发布的文件夹下面安装express

cd swagger
npm init
npm install express --save

1.4 创建目录public,并将刚才clone下来的Swagger UI中dist目录下的所有文件全部复制到public目录下面

cp -r ../swagger-ui/dist/ ./public

1.5 创建express主程序

var express = require('express');
var app = express();

// 接口显示页面
app.use('/static', express.static('public'));
app.listen(8005, function () {
  console.log('app listening on port 8005!');
});

1.6 启动服务

node swagger.js 

# 用pm2启动
pm2 start swagger.js

1.8 访问

http://192.168.185.231:8005/static/index.html
2. 替换官方的API
2.1 安装swagger-edit
git clone  https://github.com/swagger-api/swagger-editor.git
npm init
2.2 启动swagger-edit
# 直接退回swagger-edit的父目录,然后启动便可
miao@miao-VirtualBox:~/workspace$ ls 
sod  swagger  swagger-editor  swagger-ui
miao@miao-VirtualBox:~/workspace$ http-server swagger-editor
Starting up http-server, serving swagger-editor
Available on:
  http://127.0.0.1:8080
  http://192.168.185.231:8080
Hit CTRL-C to stop the server

2.3 静默启动
nohup http-server swagger-editor >> /home/miao/workspace/swagger-editor.log 2>&1 &
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,868评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,019评论 25 708
  • 现在是二零一七年十二月,大概在今年十月份之前,我的脖子就是颈椎这一块痛的真的是让人痛不欲生,当时一方面是工作上的压...
    爱吃竹子的猫阅读 180评论 0 0
  • 暗恋 青苔惹铜绿,马蹄乱红影。 霜花作怜状,痴心化苦形。
    启窗遥盼信笺红阅读 325评论 0 0
  • 《批判性思维》 R:存在着一种思维:它让我们形成意见、做出判断、做出决定、形成结论。同时,还存在着另一种思维——批...
    Nealzeng阅读 177评论 0 0