express中配置swagger并配置token信息

于 2023-12-05 11:32:27 发布
阅读量487 收藏 9
点赞数 6
分类专栏： node 文章标签： express swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39893889/article/details/134611956
版权

express中配置swagger并配置token信息

1. 安装swagger-jsdoc

 cnpm  install  swagger-jsdoc@1.3.0 --save

2. 在项目根目录下的config目录下新建swagger.js文件并添加配置项

// 引入swagger
const swaggerJSDoc = require('swagger-jsdoc')
// swagger定义
const swaggerDefinition = {
  // openapi: '3.0.1',
  info: {
    title: '若依后台管理系统 Swagger API',
    version: '1.0.0',
    description: 'Demonstrating how to describe a RESTful API with Swagger'
  },
  host: 'localhost:3007',
  basePath: '/', // 根地址
}
// swagger文档配置项
var options = {
  // import swaggerDefinitions
  swaggerDefinition: swaggerDefinition,
  // path to the API docs
  apis: ['./routes/*.js'] // 扫描routes文件夹下面的所有js文件
}
// 初始化swagger-jsdoc
const swaggerSpec = swaggerJSDoc(options)
module.exports = swaggerSpec

在这里插入图片描述

3. 在app.js中使用

// 引入swagger配置项
const swaggerSpec = require('./config/swagger')
app.get('/swagger.json', function(req, res) {
  res.setHeader('Content-Type', 'application/json')
  res.send(swaggerSpec)
})

4. 在项目的public文件夹下添加api-docs文件夹

4.1 引入dist文件

在项目的public文件夹下添加api-docs文件夹，将https://github.com/swagger-api/swagger-ui中的dist文件夹下的内容全部放入api-docs文件夹中。
在这里插入图片描述

4.2 修改配置地址

修改swagger-initializer.js文件中的url为当前项目的启动地址

url : "http://petstore.swagger.io/v2/swagger.json";
 改为
url: "http://localhost:3007/swagger.json",  // express项目启动端口

在这里插入图片描述

5. 查看swagger

http://localhost:3007/api-docs/index.html#/

在这里插入图片描述

get类型接口注释

/**
 * @swagger
 * /user/list:
 *   get:
 *     tags:
 *       - 用户信息
 *     summary: 获取用户列表
 *     description:
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: pageSize
 *       in: query
 *       required: false
 *       type: Number
 *       - name: pageNum
 *       in: query
 *       required: false
 *       type: Number
 *     responses:
 *       200:
 *         description: 查询成功，返回JSON格式的用户信息
 *       400:
 *         description: 失败
 */
router.get('/user/list',AccountService.findAll)

query参数

    parameters:
      - name: pageSize
        in: query
        required: false
        type: Number
      - name: pageNum
        in: query
        required: false
        type: Number

path参数

    parameters:
      - in: path
        name: userId
        required: true
        description: 用户ID

在这里插入图片描述

post类型接口注释

/**
 * @swagger
 * /mine/seam/save:
 *   post:
 *     tags:
 *       - 用户信息
 *     summary: 新增用户
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: seamName
 *         description: 用户名称
 *         required: true
 *         type: string
 *       - name: seamNumber
 *         description: 用户编号
 *         in: formData
 *         example: 煤层1
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: 成功
 *       400:
 *         description: 失败
 */
router.post('/mine/seam/save',AccountService.login)

put类型接口注释

/**
 * @swagger
 * /edit:
 *   put:
 *     tags:
 *       - /movies/account
 *     summary: 编辑用户信息接口
 *     description: 修改用户信息。提交表单数据，根据用户id对用户信息进行修改
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: userId
 *         description: 用户id,用户的唯一标示符
 *         in: body
 *         required: true
 *         schema:
 *           type: string
 *           properties:
 *               userId:
 *                 example: 1001
 *       - name: userName
 *         description: 用户名
 *         in: body
 *         required: true
 *         schema:
 *           type: string
 *           properties:
 *               userName:
 *                 example: '张三'
 *       - name: userSex
 *         description: 用户性别
 *         in: body
 *         required: true
 *         schema:
 *           type: string
 *           properties:
 *               userSex:
 *                 example: '男'
 *       - name: userAddress
 *         description: 用户地址
 *         in: body
 *         required: true
 *         schema:
 *           type: string
 *           properties:
 *               userAddress:
 *                 example: '陕西省 西安市'
 *     responses:
 *       200:
 *         description: 修改成功，返回JSON格式数据
 *         schema:
 *           type: object
 *           properties:
 *             code:
 *               type: integer
 *               example: 200
 *             msg:
 *               type: string
 *               example: "修改成功"
 *       401:
 *         description: 修改失败，返回JSON格式数据
 *         schema:
 *           type: object
 *           properties:
 *             code:
 *               type: integer
 *               example: 401
 *             msg:
 *               type: string
 *               example: '修改失败'
 */
router.put('/edit',AccountService.editAccount)

delete类型接口注释

/**
 * @swagger
 * /user/{userId}:
 *   delete:
 *     tags:
 *       - 用户信息
 *     summary: 删除用户
 *     produces:
 *       - application/json
 *     parameters:
 *       - in: path
 *         name: userId
 *         required: true
 *         description: 用户ID
 *     responses:
 *       200:
 *         description: 成功
 *       400:
 *         description: 失败
 */

在这里插入图片描述

接口中配置Authorization

第一步：在swagger.js文件中添加相关配置

  securityDefinitions: {
    Authorization: {
      type: 'apiKey',
      in: 'header',
      name: 'Authorization',
      description: ''
    }
  }

第二步：在接口注释处添加配置

    security:
      - Authorization:

swagger.js文件整体配置如下：

// 引入swagger
const swaggerJSDoc = require('swagger-jsdoc')
// swagger定义
const swaggerDefinition = {
  info: {
    title: '若依后台管理系统 Swagger API',
    version: '1.0.0',
    description: 'Demonstrating how to describe a RESTful API with Swagger'
  },
  host: 'localhost:3007',
  basePath: '/', // 根地址
  produces: ['application/json', 'application/xml'],
  schemes: ['http', 'https'],
  securityDefinitions: {
    Authorization: {
      type: 'apiKey',
      in: 'header',
      name: 'Authorization',
      description: ''
    }
  }
}
// swagger文档配置项
var options = {
  // import swaggerDefinitions
  swaggerDefinition: swaggerDefinition,
  // path to the API docs
  apis: ['./routes/*.js'] // 扫描routes文件夹下面的所有js文件
}
// 初始化swagger-jsdoc
const swaggerSpec = swaggerJSDoc(options)
module.exports = swaggerSpec

接口注释整体配置如下：

/**
 * @swagger
 * /mine/seam/list:
 *   get:
 *     tags:
 *       - 矿井管理-煤层信息
 *     summary: 获取煤层信息列表
 *     description:
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: pageSize
 *         in: query
 *         required: false
 *         type: Number
 *       - name: pageNum
 *         in: query
 *         required: false
 *         type: Number
 *       - name: seamName
 *         in: query
 *         required: false
 *         type: string
 *     responses:
 *       200:
 *         description: 成功
 *       400:
 *         description: 失败
 *     security:
 *       - Authorization:
 */

swagger ui界面及配置操作如下：

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述在这里插入图片描述
在这里插入图片描述

参考地址

链接1
链接2
链接3
OpenAPI

从不讲道理
关注
  • 6
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
express-starter:支持 cronjob、i18n、swagger、joi 验证、jwttoken 验证、上传文件
07-24
“# express-starter” 文档 快速开始 运行以下命令 我的 npm 运行开发 转到 http:localhost:5000/documentation 转到 api/test 文件夹来探索它是如何工作的 1/ 路由器 在具有“Route.js”后缀的“api”文件夹中...
nodejs + express 配置 swaggerUI
TheHtmler的博客
01-17 1266
一 启动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/
从0到1 express 安装swagger
leechoy
10-22 3210
从0到1express 安装swagger.Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器,在我们后端开发中，swagger可以可视化的提供测试服务。
swagger页面直接添加token+网关验证
cxywangshun的博客
06-17 2249
swagger添加token验证
swagger 添加Token
热门推荐
小小董的博客
07-05 1万+
后台有权限认证是springboot+jwt+shiro+swagger的，swagger配置token 1 首先在pom文件引入 依赖： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2...
从业卡管理系统后端-前后端分离 SpringBoot+Vue+Swagger+JWT token
05-15
【项目资源】：包含前端、后端、移动开发、操作系统、人工智能、物联网、信息化管理、数据库、硬件开发、大数据、课程资源、音视频、网站开发等各种技术项目的源码。包括STM32、ESP8266、PHP、QT、Linux、iOS、C++、...
MyInbox:一个MEAN Stack项目，用于管理电子邮件等
05-09
我的收件箱 一个MEAN Stack项目，用于管理电子邮件等 #Resources : ##Front end: - https://material.angularjs.org/latest/Theming/01_introduction - ...Toast message: ...Animated Icons: ...
template_express
05-13
[2、token的验证、刷新]配合前端地址： [3、apidoc(弃用;原因可能是自己的打开方式不对，接口文档不能按照注释的更新)] 1 全局安装apidoc npm install -g apidoc 2 根目录创建apidoc.json文件 3 apidoc -i ./...
jaebook-server：使用Express.js和TypeScript制作的Board REST API服务器
02-05
eBook JaeBook服务器使用TypeScript和Express。 前端：文章项目特色使用TypeScript进行表达结构控制器，服务，存储库，模型，中间件的优美结构。 TypeORM受其他ORM的影响很大，例如Hibernate，Doctrine和Entity ...
express-starter-kit：该存储库是使用express js进行基于API的开发的样板。 该应用程序包含所有开发工具，包括swagger和swager ui文档工具，mocha和chai测试工具，猫鼬驱动器集成，MCV模式明智的编码样式，用于身份验证的JSON Web令牌以及更多其他工具
02-04
开发人员可以在开发过程中轻松地对api进行编码，测试和记录。 它还具有良好的体系结构，可帮助开发人员维护代码。 安装 安装过程很容易，您只能从git下载或克隆应用程序 从git clone ...
dotapp-framework：建立在express.js之上的轻巧，薄且功能齐全的Node.js框架
02-03
点应用一个基于express.js构建的小巧轻便且功能齐全的nodejs框架。 DOTAPP附带了完整集成的开源库的组合，以节省开发时间，例如用户，充当媒体。要求的NodeJS> = 12.0.0 吉特mongodb安装$ npm install -g dotapp-cli...
nodejs-auth-jwt:使用JWT进行节点身份验证
05-16
nodejs Express JWT 使用JWT登录应用程序示例 运行项目： $ npm init $ npm install $ sudo npm install -g nodemon $ nodemon API路线： get: /api post: /api/posts post: /api/login post: /api/posts Header:...
node-mysql：带有mysql样板的节点
02-04
带有MySQL BoilerPlate /... 它包含Pm2，可帮助重新启动，重新加载和监视生产中的应用程序，并提供零停机时间可用性。 它具有Nodemailer，它将发送电子邮件。 它具有bcrypt模块，该模块将加密密码并使其更加安全。 它包
MERN-boilerplate
03-20
MERN样板MERN Boilerplate是一项采用以下技术的项目： Express JS React JS Redux MongoDB /猫鼬打字稿节点安装使用以下模板在根目录中设置.env文件： CLUSTER=NODE_ENV=PORT=FRONTEND_URL=ACCESS_TOKEN_SECRET=...
课程设计基于Java实现的校园快递代拿系统源码+sql数据库+项目详细说明.zip
08-10
10. 也有整合swagger（layui），访问地址是 ip:port + context-path + /docs.html，例如localhost:40200/order/docs.html或http://localhost:40300/docs.html，如果提示Access token expired请清除cookie ...
DP读书：鲲鹏处理器 架构与编程（六）PCI Express 总线
DarrenPig的博客
08-16 1995
PCI Express总线的拓扑发现是指通过一定的协议和机制，在系统中识别和确定PCI Express设备的连接关系和数据传输路径的过程。根据不同的事务类型，事务层会产生不同类型的TLP报文，并根据不同的路由方式进行数据转发。总之，PCI Express总线中的另一个重要组件是PCI Express桥，它的作用是将PCI Express总线连接到其他类型的总线或设备，从而形成一个更大的网络。通过以上步骤，可以获取PCI Express总线的拓扑结构，包括设备的连接关系、设备的配置信息和数据传输路径等。
python源码基于mediapipe设计实现人体姿态识别动态时间规整算法DTW和LSTM（长短期记忆循环神经网络.rar
05-19
本项目基于Python源码，结合MediaPipe框架，实现了人体姿态识别功能，并进一步采用动态时间规整算法（DTW）和长短期记忆循环神经网络（LSTM）对人体动作进行识别。项目涵盖了从姿态估计到动作识别的完整流程，为计算机视觉和机器学习领域的研究与实践提供了有价值的参考。 MediaPipe是一个开源的多媒体处理框架，适用于视频、音频和图像等多种媒体数据的处理。在项目中，我们利用其强大的姿态估计模型，提取出人体的关节点信息，为后续的动作识别打下基础。DTW作为一种经典的模式匹配算法，能够有效地处理时间序列数据之间的差异，而LSTM则擅长捕捉长时间序列中的依赖关系。这两种算法的结合，使得项目在人体动作识别上取得了良好的效果。 经过运行测试，项目各项功能均表现稳定，可放心下载使用。对于计算机相关专业的学生、老师或企业员工而言，该项目不仅是一个高分资源，更是一个难得的实战演练平台。无论是作为毕业设计、课程设计，还是项目初期的立项演示，本项目都能为您提供有力的支持。
web期末大作业-电影动漫的源码案例.rar
最新发布
05-19
本学期末，我们为您呈现一份精心准备的电影动漫源码案例，它不仅是课程设计的优秀资源，更是您实践技能的有力提升工具。经过严格的运行测试，我们确保该案例能够完美兼容各种主流开发环境，让您无需担心兼容性问题，从而更加专注于代码的学习与优化。 这份案例资源覆盖了前端设计、后端逻辑处理、数据库管理等多个关键环节，旨在为您提供一个全面而深入的学习体验。无论您是计算机专业的在校学生，还是对编程充满热情的爱好者，亦或是希望提升技能的企业员工，这份案例都将为您提供宝贵的实战经验。 此外，我们还特别准备了详细的使用指南和在线支持，确保您在学习和使用的过程中能够得到及时有效的帮助。您可以放心下载和使用这份资源，让它成为您学习道路上的得力助手。让我们携手共进，通过实践探索编程的无限可能！
swagger配置token
10-12
在Swagger中配置token需要在请求头中添加Authorization字段，值为Bearer加上空格再加上token值。具体操作步骤如下： 1. 在Swagger UI页面中找到需要添加token的接口 2. 点击"Authorize"按钮，输入token值并保存 3. 在请求头中添加Authorization字段，值为Bearer加上空格再加上token值

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值