[Nestjs] 集成 Swagger

简介: 安装 Swagger 模块:首先,使用 npm 或者 yarn 安装 @nestjs/swagger 模块。

安装 Swagger 模块:首先,使用 npm 或者 yarn 安装 @nestjs/swagger 模块。


npm install @nestjs/swagger swagger-ui-express


配置 Swagger 模块:在你的 NestJS 应用的根模块(通常是 app.module.ts)中进行配置。

import { Module } from '@nestjs/common';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppController } from './app.controller';
import { AppService } from './app.service';
@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {
  constructor() {
    const config = new DocumentBuilder()
      .setTitle('Your API')
      .setDescription('API description')
      .setVersion('1.0')
      .build();
    const document = SwaggerModule.createDocument(this.app, config);
    SwaggerModule.setup('api', this.app, document);
  }
}

上述代码中,你需要调整 setTitlesetDescriptionsetVersion 方法中的参数,以反映你自己的 API 标题、描述和版本。


在控制器类上添加装饰器:在每个控制器类上添加 @ApiTags() 装饰器,并指定与该控制器相关的标签。

import { Controller, Get } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
@Controller('cats')
@ApiTags('cats') // 这里指定与该控制器相关的标签
export class CatsController {
  @Get()
  findAll(): string {
    return 'This action returns all cats';
  }
}

在上述示例中,我们使用 @ApiTags() 装饰器将 CatsController 控制器与 "cats" 标签关联起来。


启动应用程序:启动你的 NestJS 应用程序,在浏览器中访问 /api 或者 /swagger 路径即可查看 Swagger UI 界面,并浏览和测试 API。

f6088447ca6540f4bba03ac356178d2b.png

ea07f826a38340a3bd3520cb049ff6bf.png

这样,你就成功将 Swagger 集成到了你的 NestJS 应用中。现在你可以使用 Swagger 自动生成的文档来描述和测试你的 API 接口。


这里只做了简单的集成,更多参数请看Swagger官方文档

相关文章
|
4月前
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
4月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
23天前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
45 1
|
2月前
|
开发工具 Python
django之drf集成swagger
django之drf集成swagger
|
2月前
|
Java Spring
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
本文介绍了如何在Spring Boot项目中集成Swagger 2.x和3.0版本,并提供了解决Swagger在Spring Boot中启动失败问题“Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerEx”的方法,包括配置yml文件和Spring Boot版本的降级。
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
|
3月前
|
Java API Spring
springboot集成swagger
这篇文章介绍了如何在Spring Boot项目中集成Swagger 2.10.0来生成API文档,包括添加依赖、编写配置类、创建接口文档,并使用Knife4j美化Swagger界面。
|
4月前
|
JSON 缓存 Java
Spring Boot集成 Swagger2 展现在线接口文档
本节课详细分析了 Swagger 的优点,以及 Spring Boot 如何集成 Swagger2,包括配置,相关注解的讲解,涉及到了实体类和接口类,以及如何使用。最后通过页面测试,体验了 Swagger 的强大之处,基本上是每个项目组中必备的工具之一,所以要掌握该工具的使用,也不难。
|
5月前
|
安全 Java API
技术笔记:SpringBoot集成Swagger3.0(详细)
技术笔记:SpringBoot集成Swagger3.0(详细)
|
5月前
|
Java
springboot集成swagger2并分组全局设置Authorization
springboot集成swagger2并分组全局设置Authorization
163 0