首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

NestJS -如何在Swagger中公开参数

NestJS是一个基于Node.js的开发框架,用于构建可扩展的、高效的服务器端应用程序。Swagger是一种用于描述、构建、测试和文档化 RESTful Web服务的工具。

在NestJS中公开参数到Swagger中,可以通过使用装饰器@ApiProperty()@ApiBody()来完成。以下是一种常见的方法:

  1. 首先,确保你已经在项目中安装了NestJS和Swagger插件。可以通过以下命令进行安装:
代码语言:txt
复制
npm install @nestjs/swagger swagger-ui-express
  1. 在NestJS的控制器类或方法上使用@ApiProperty()装饰器来定义参数。例如,在一个POST请求的控制器方法中,可以这样定义参数:
代码语言:txt
复制
import { ApiProperty } from '@nestjs/swagger';

// ...

@Post()
@ApiProperty({ description: '用户登录' })
async login(@Body() loginDto: LoginDto) {
  // ...
}
  1. 在NestJS的控制器类上使用@ApiOperation()装饰器来定义操作的描述。例如,在控制器类中添加以下代码:
代码语言:txt
复制
import { ApiOperation } from '@nestjs/swagger';

// ...

@ApiTags('用户')
@Controller('users')
export class UsersController {
  // ...

  @ApiOperation({ summary: '用户登录' })
  @Post()
  async login(@Body() loginDto: LoginDto) {
    // ...
  }
}
  1. 在NestJS的入口文件(通常是main.ts)中添加Swagger的配置。例如:
代码语言:txt
复制
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

// ...

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // 配置Swagger
  const config = new DocumentBuilder()
    .setTitle('API 文档')
    .setDescription('API 文档描述')
    .setVersion('1.0')
    .addTag('用户')
    .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

  await app.listen(3000);
}
bootstrap();

现在,当你启动应用程序并访问http://localhost:3000/api时,将会看到生成的Swagger文档,并且你定义的参数和操作描述也会在文档中显示出来。

对于NestJS的相关文档和腾讯云产品推荐,可以参考以下链接:

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券