Windows下部署Swagger Edit、Swagger UI

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源码会将相应版本库一并下载到本地,内容较多),链接如下。下载完成解压到刚才创建的目录

方式二(需要安装了git客户端):从github clone源码,命令如下

在这里插入图片描述


我这里是以方式二做的实例(注意结合自己的路径及源码包名,可能会不同)。

在这里插入图片描述

三、搭建Swagger Editor

2.cmd命令行定位到swagger-editor源码包内

  • 执行 npm install
    (安装相应依赖模块)

在这里插入图片描述

  • 执行 npm start 启动应用 (以后启动直接执行这个命令就行)
    (可以省略npm install直接执行这一步,因为这一步也会执行npm install命令,要是之前执行过了,这一步就直接加载文件启动了)。

在这里插入图片描述


3.根据相应提示访问Swagger Edit

在这里插入图片描述


在这里插入图片描述

四、搭建Swagger UI

4.进入swagger-ui源码包

在这里插入图片描述

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),可以进行如下更改。

相关文章

Windows2012R2备用域控搭建 前置操作 域控主域控的主dns:自...
主域控角色迁移和夺取(转载) 转载自:http://yupeizhi.blo...
Windows2012R2 NTP时间同步 Windows2012R2里没有了internet时...
Windows注册表操作基础代码 Windows下对注册表进行操作使用的...
黑客常用WinAPI函数整理之前的博客写了很多关于Windows编程的...
一个简单的Windows Socket可复用框架说起网络编程,无非是建...