express增加swagger功能

本文介绍如何使用Swagger UI创建本地API文档。主要内容包括下载Swagger UI库、配置Express项目以加载库文件及swagger.json文件,并通过修改index.html来引用本地JSON文件。最后运行本地项目即可预览效果。

参考地址:https://blog.youkuaiyun.com/freeboy1234/article/details/79289486

 


 

下载swagger ui库

地址是:https://github.com/swagger-api/swagger-ui

 


将Swagger项目文件复制至本地项目中

创建express项目,将swagger ui库中的dist文件夹加入至public文件夹中

1.源文件夹

2.目标文件夹,红色圈圈中的swgger.json是在https://editor.swagger.io/中生成的,下载至本地项目中

 


Express增加代码,将Public目录公开

在开始运行的代码中,增加以下代码

express.static(path.join(__dirname, 'public'))

 


引用swagger json文件 

打开https://editor.swagger.io/,将显示出示例文件,将示例文件下载至本地项目public文件夹中

然后在index.html修改内容,默认是官方的地址,这里修改为本地的json文件

 


 

运行本地项目

打开本地项目,查看http://localhost:3000/,即可以看到效果

 

转载于:https://www.cnblogs.com/weschen/p/10655365.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值