如何用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添加对应的逻辑即可

相关推荐
狮子座的男孩11 小时前
html+css基础:31、响应式布局(媒体类型,媒体特性,运算符,常用阈值)
前端·css·经验分享·html·响应式布局·媒体类型/特性·常用阈值
鲸鹏芯海微电子科技 (上海) 有限公司11 小时前
手机直连卫星,射频前端到底要解决什么?
前端·智能手机·低轨卫星·謓泽·鲸鹏芯海·毫米波射频·相控阵芯片
Flynt11 小时前
npm run dev --host 有风险?我把 Vite 这个 9.1 分漏洞复现了一遍
前端·vite
AI开源软件11 小时前
Vue3+SpringBoot3 业务配置统一管理:接管、保存与回退怎样保留有效值
java·前端·vue.js·spring boot·vue·ruoyi office
1-1=011 小时前
Vue 脚手架
前端·javascript·vue.js
snow@li11 小时前
node:读取本地文件/静态文件服务器/打开Axure原型/prototype-server
前端·node
狮子座的男孩12 小时前
html+css基础:32、BFC(父子元素防止 margin 塌陷,父子元素清除浮动,兄弟元素两栏布局)
前端·css·经验分享·html·bfc·margin塌陷·清除浮动
zhanlang021712 小时前
HTML 零基础入门到企业实战全套教程【第八章 8.3】HTML5 语义化标签|SEO 优化、页面布局实战应用
前端·html·html5
SameX12 小时前
HarmonyOS 保存组件截图到相册 componentSnapshot 到 photoAccessHelper 完整链
前端
曹一二12 小时前
彻底搞懂 JS 对象:从字面量、构造函数到原型链与包装类
前端·javascript