如何用nest生成一份swagger文档

首先新建项目

arduino 复制代码
nest new swagget -p npm

然后安装nest/swagger

css 复制代码
npm install --save @nestjs/swagger

然后在主入口文件main.ts里添加

javascript 复制代码
 const documentConfig = new DocumentBuilder()
    .setTitle('swagger example')
    .setDescription('The API description')
    .setVersion('1.0')
    .addTag('swagger')
    .build();
  const document = SwaggerModule.createDocument(app, documentConfig);
  SwaggerModule.setup('doc', app, document);
  1. DocumentBuilder 创建 documentConfig。
  2. 然后用 SwaggerModule.createDocument 根据 config 创建文档。
  3. 之后用 SwaggerModule.setup 指定在哪个路径可以访问文档。

然后启动项目

arduino 复制代码
pnpm run start:dev

访问 http://localhost:3000/doc 就可以看到 swagger 的 api 文档了:

让我们在生成一份 Rest API的接口文档

复制代码
nest generate resource swaggerdemo

刷新页面就会看到最新的文档了

接着只要在每个controller添加对应的逻辑即可

相关推荐
烛阴1 小时前
Mix
前端·webgl
代码续发1 小时前
前端组件梳理
前端
试图让你心动2 小时前
原生input添加删除图标类似vue里面移入显示删除[jquery]
前端·vue.js·jquery
陈不知代码2 小时前
uniapp创建vue3+ts+pinia+sass项目
前端·uni-app·sass
小王码农记2 小时前
sass中@mixin与 @include
前端·sass
陈琦鹏2 小时前
轻松管理 WebSocket 连接!easy-websocket-client
前端·vue.js·websocket
hui函数3 小时前
掌握JavaScript函数封装与作用域
前端·javascript
行板Andante3 小时前
前端设计中如何在鼠标悬浮时同步修改块内样式
前端
Carlos_sam4 小时前
Opnelayers:ol-wind之Field 类属性和方法详解
前端·javascript
小毛驴8504 小时前
创建 Vue 项目的 4 种主流方式
前端·javascript·vue.js