express集成express-swagger-generator以及相应注意点

使用方法可看这位博主https://blog.csdn.net/Govern66/article/details/104792847

不得不说,配置起来很简单,但是这个文档很不友善,对于初学者,有些不常用的配置完全不知道怎么弄。

本人在项目中使用这个遇到的坑:

1、配置好express-swagger-generator后,已经带有jwt配置了如下图:

express集成express-swagger-generator以及相应注意点_第1张图片

但是给swagger赋token,接口依然提示401,查看github,发现需要在要jwt验证的接口注释中加入 这句话@security JWT,

切记要加在注释最后面,不然可能不生效。

2、对于这种api路径  router.delete('/deleteUser/:id')需要一下配置:(注意红色字体)

 * @route GET /userInfo/{userId} 查询用户

 * @summary 查询用户

 * @group user - 用户模块

 * @param {number} userId.path.required

 * @returns {object} userInfo

 * @security JWT

我们需要注意 @param {number} userId.path.required userId.path才会生效

然后接口里就使用params来获取id

 

你可能感兴趣的:(express)