常用Swagger 装饰器 装饰器描述 @ApiTags 为控制器或方法添加标签,用于组织 Swagger UI 文档 @ApiOperation 为控制器方法添加操作描述,包括摘要和详细描述 @ApiParam 描述路径参数、请求参数或响应参数,包括名称、类型、描述等 @ApiBody 指定请求体的 DTO 类型,用于描述请求体的结构 @ApiResponse 描述API 的响应,包...
回到Swagger 文档中,只需要@ApiResponse({ type: TodoEntity })改写成@ApiResponse({ type: ResOp<TodoEntity> }),就可以实现下图需求。 自定义 Api 装饰器 然后对于庞大的业务而言,使用@ApiResponse({ type: ResOp<TodoEntity> })的写法,肯定不如@ApiResponse({ type: TodoEntity })来的高效,有没有什么办...
import{Controller,Get,Query}from'@nestjs/common';import{ApiOkResponse,ApiOperation,ApiTags}from'@nestjs/swagger';// swagger 接口文档import{PostParamsDto}from'./dto/params-post.dto';import{ResponsePostDto}from'./dto/response-post.dto';import{PostManageService}from'./post-manage.service';@ApiTa...
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";async function bootstrap() {// *** 其它代码省略 ***const config = new DocumentBuilder().setTitle("nest-demo").setDescription("nest-demo项目的API使用文档").setVersion("1.0.0").build();const document = SwaggerModule.createDoc...
import { ApiProperty } from '@nestjs/swagger'; export class CreateMakaloDto { @ApiProperty({ description: "姓名", example: "makalo" }) name: string @ApiProperty({ description:"年龄", example: "18"}) age: number } ApiResponse 自定义返回信息 @ApiResponse({status:403,description:"自定...
常用Swagger 装饰器 装饰器描述 @ApiTags 为控制器或方法添加标签,用于组织 Swagger UI 文档 @ApiOperation 为控制器方法添加操作描述,包括摘要和详细描述 @ApiParam 描述路径参数、请求参数或响应参数,包括名称、类型、描述等 @ApiBody 指定请求体的 DTO 类型,用于描述请求体的结构 @ApiResponse 描述API 的响应,包...
AuthConfigSwagger.API_RES_CREATE是 static readonly API_RES_CREATE: ApiResponseOptions = { description: 'The user has been successfully created.', type: User }; 该响应不是我创建的真实响应。这样,我就显示了整个文档(我正在使用 mongoDb) 我需要输入我的自定义回复,例如 { "statusCode": 201, "me...
通常情况下,在 nest.js 的 swagger 页面文档中的响应数据文档默认如下 此时要为这个控制器添加响应数据文档的话,只需要先声明 数据的类型,然后通过@ApiResponse 装饰器添加到该控制器上即可,举例说明 todo.entity.ts 代码语言:javascript 复制 @Entity('todo') export class TodoEntity { @Column() @ApiProperty(...
@ApiResponse注解,用于对接口的返回数据进行描述。 关于上述各个注解的具体使用方法可参考我的项目代码,如下所示: AppController.ts[1] AppDto.ts[2] ResultVO[3] 经过上述配置后 ,最终访问效果如下所示: image-20220317224923516 ❝有关swagger注解的更多使用方法请移步:OpenAPI (Swagger)[4] ...
@ApiQuery({name:"xxxx",description:"bbb"}) 1. ApiProperty 定义Post import { ApiProperty } from "@nestjs/swagger" export class CreateGuardDto { @ApiProperty({ description: "姓名", example: "小满" }) name: string @ApiProperty({ description:"年龄"}) ...