Windows下部署Swagger Edit、Swagger UI
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了Windows下部署Swagger Edit、Swagger UI，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含2263字，纯文字阅读大概需要4分钟。
内容图文
Windows下部署Swagger Edit、Swagger UI
一、环境需求——已安装node环境
可以参考我的另一篇文章Windows下安装nodejs
二、准备Swagger Editor、Swagger UI源码
1.下载Swagger Editor、Swagger UI的源码(swagger-api的github地址：https://github.com/swagger-api)
- 创建目录(我的是 E:\swagger_test)用于存放以上源码
方式一(推荐)：下载源码压缩包(内存较小，clone源码会将相应版本库一并下载到本地，内容较多)，链接如下。下载完成解压到刚才创建的目录
- https://github.com/swagger-api/swagger-editor/archive/master.zip
- https://github.com/swagger-api/swagger-ui/archive/master.zip
方式二(需要安装了git客户端)：从github clone源码，命令如下
- git clone https://github.com/swagger-api/swagger-editor.git
- git clone https://github.com/swagger-api/swagger-ui.git
我这里是以方式二做的实例(注意结合自己的路径及源码包名,可能会不同)。
三、搭建Swagger Editor
2.cmd命令行定位到swagger-editor源码包内
- 执行 npm install
(安装相应依赖模块)
- 执行 npm start 启动应用 (以后启动直接执行这个命令就行)
(可以省略npm install直接执行这一步，因为这一步也会执行npm install命令，要是之前执行过了，这一步就直接加载文件启动了)。
3.根据相应提示访问Swagger Edit
四、搭建Swagger UI
4.进入swagger-ui源码包
- 新建index.js文件，内容如下
var express = require('express');
var app = express();
app.use('/', express.static('dist'));
app.listen(3002, function () {
console.log('Starting up listening on port 3002!\nAvaiable on:\n http://127.0.0.1:3002 \nHit CTRL-C to stop the server');
});
5.cmd命令行定位到swagger-ui源码包内,安装express服务器
- npm install express –g
6.启动应用 (以后启动直接执行这个命令就行)
- node index.js
7.根据相应提示访问Swagger UI
8.到这里本地部署Swagger Edit、Swagger UI已经完成了，以后可以离线状态下使用这两个工具了。
五、Swagger UI 的简单使用
9.将在Swagger Editor中保存下来的文档放到swagger-ui的dest下的相应目录下(可以创建json、yaml文件夹分别用于存放这两种格式的API接口文档)
10.比如上一步在swagger-ui/dest/json目录下存放了swagger.json接口文档，在Swagger UI里就可以这么访问到。
11.当然为了便于离线使用(Swagger UI默认url路径为官方的案例，我们可以将它改为本地的url)，可以进行如下更改。
- 打开dest目录下index.html文件
将 url: “https://petstore.swagger.io/v2/swagger.json”
更改为 url: “/json/swagger.json”
内容总结
以上是互联网集市为您收集整理的Windows下部署Swagger Edit、Swagger UI全部内容，希望文章能够帮你解决Windows下部署Swagger Edit、Swagger UI所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。