使用Swagger UI展示各种OpenAPI文档

1 安装Node.js

swagger ui 依赖Node.js,点击下载Node.js

2 安装Swagger UI

 npm install -g swagger-ui

3 克隆Swagger UI源码

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

4 安装依赖

进入swagger-ui的源码目录,安装依赖

cd swagger-ui
npm install
npm install http-server

5 替换的你API文档

  • 进入swagger ui的工程根目录
  • 进入dist目录,在dist目录下新建一个文件,如index.yaml(名字随便)
  • 将你的OpenAPI文档内容复制到index.yaml
  • 修改dist目录下的index.html文件,指定文档路径为的你的OpenAPI文件
  •  const ui = SwaggerUIBundle({
       url: "index.yaml", // 替换为你的OpenAPI文件
     }) 
    

6 启动

在命令行中导航到swagger ui的项目目录,然后运行以下命令来启动http-server

npx http-server -p 8080

-p 后面是指定的端口号
在这里插入图片描述

7 查看

启动http-server时,会有一些信息显示哪些地址可以输入

  • 本地电脑:在浏览器上输入127.0.0.1:8080, 回车就能看到你的OpenAPI文档,
  • 局域网的其他电脑:输入 http://192.168.5.149:8080 就能查看。
  • 6
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值