不生成swagger文档 - Node JS + swaggerJSDoc
创始人
2024-12-28 03:31:33
0次

要在Node.js中使用swaggerJSDoc来生成swagger文档,可以按照以下步骤操作:

  1. 首先,确保已经在项目中安装了swagger-jsdoc和swagger-ui-express依赖项。可以使用以下命令在项目目录中进行安装:
npm install swagger-jsdoc swagger-ui-express
  1. 创建一个新的js文件(例如swagger.js),在其中添加以下代码:
const express = require('express');
const swaggerJSDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const app = express();
const port = 3000;

// Swagger文档配置
const swaggerOptions = {
  swaggerDefinition: {
    info: {
      title: 'API文档',
      version: '1.0.0',
      description: 'API文档生成示例'
    },
    basePath: '/'
  },
  apis: ['./routes/*.js'] // 指定API路由文件的路径
};

// 生成swagger规范
const swaggerSpec = swaggerJSDoc(swaggerOptions);

// 使用Swagger UI中间件来提供API文档
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

// 在此处定义API路由
// 例如:app.use('/api/users', require('./routes/users'));

// 启动服务器
app.listen(port, () => {
  console.log(`服务器正在监听端口 ${port}`);
});
  1. 在项目中创建一个routes文件夹,并在其中创建一个js文件(例如users.js),以定义API路由。在该文件中,使用swaggerJSDoc提供的JSDoc注释来描述API接口。例如:
/**
 * @swagger
 * /api/users:
 *   get:
 *     summary: 获取所有用户
 *     description: 获取所有用户的列表
 *     responses:
 *       200:
 *         description: 成功获取用户列表
 */
router.get('/api/users', (req, res) => {
  // 处理获取用户列表的逻辑
});
  1. 在命令行中运行以下命令启动服务器:
node swagger.js
  1. 在浏览器中访问http://localhost:3000/api-docs,即可查看生成的swagger文档。

以上就是使用Node.js和swaggerJSDoc生成swagger文档的解决方法。务必根据自己的项目需求和API接口配置相应的swaggerOptions和路由。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...