nodejs + express 配置 swaggerUI

2 篇文章 0 订阅
1 篇文章 0 订阅

一 启动node服务

app.js

const express = require('express')

const app = new express()

// run server
const server = app.listen(5002, () => {
  console.log('Http server running on port 5002')
})

二 下载swagger及集成到app.js

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

Tips:用clone下载太慢,直接下载zip包

将下载好的swagger包中的dist全部复制粘贴到自己项目根目录下的public文件夹中

app.js

const express = require('express')
const path = require('path')

const app = new express()

// 注意:写在请求拦截前面
app.use('/api/swagger_ui', express.static(path.join(__dirname, 'public')))

// 请求拦截
// app.use('*', (req, res, next) => {
    // 拦截处理,如设置请求跨域
// })

// run server
const server = app.listen(5002, () => {
  console.log('Http server running on port 5002')
})

注意:在配置 /api/swagger_ui 路由时,如果 app.js 中有配置 app.all('*') 或者 app.use('*') 请求头时,记得将 swagger 路由写在此前,否则你打开的就是源码,不是渲染的 html

三、配置 swagger.json

swagger在线编辑:https://editor.swagger.io/

配置好json后,点击editor页面左上角File的convert and save as json,会自动下载配好的json,将这个json放进public目录下,并且在index.html中SwaggerUIBundle方法替换原有的在线配置url,指向本地地址即可

 

四、关于Authorization token的配置

我用的是 bearer,在securityDefinitions配置,然后在每个需要token验证的api接口添加即可

PS:(配置json着实花了很久0-0)暂时先整理个入门文档,后续再补充...

 

 

评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值