NestJs/Swager（OpenAPI）在查询参数中定义嵌套对象

Question

我正在尝试正确定义 OpenAPI 规范，以便从该规范生成 api 客户端。我已经解决了一个问题，即我们有一个复杂的查询对象，其中包含嵌套对象和对象数组，用于获取 GET 路由。

让我们以这些类为例。

class Person {
  @ApiProperty()
  name!: string
  @ApiProperty()
  location!: string
}

class CompanyDto {
  @ApiProperty()
  name!: string

  @ApiProperty({
    type: [Person],
  })
  employees!: Person[]
}

和一个带有@Query decorator的get请求。

  @Get('test')
  async testing(@Query() dto: CompanyDto): Promise<void> {
    // ...
  }

我得到的是。

    {
      get: {
        operationId: 'testing',
        parameters: [
          {
            name: 'name',
            required: true,
            in: 'query',
            schema: {
              type: 'string',
            },
          },
          {
            name: 'name',
            in: 'query',
            required: true,
            schema: {
              type: 'string',
            },
          },
          {
            name: 'location',
            in: 'query',
            required: true,
            schema: {
              type: 'string',
            },
          },
        ],
        responses: {
          '200': {
            description: '',
          },
        },
        tags: ['booking'],
      },
    }

我还尝试通过添加@ApiQuery装饰器来定义查询参数，它几乎可以工作。

  @ApiQuery({
    style: 'deepObject',
    type: CompanyDto,
  })

-

{
  get: {
    operationId: 'testing',
    parameters: [
      {
        name: 'name',
        required: true,
        in: 'query',
        schema: {
          type: 'string',
        },
      },
      {
        name: 'name',
        in: 'query',
        required: true,
        schema: {
          type: 'string',
        },
      },
      {
        name: 'location',
        in: 'query',
        required: true,
        schema: {
          type: 'string',
        },
      },
      {
        name: 'name',
        in: 'query',
        required: true,
        schema: {
          type: 'string',
        },
      },
      {
        name: 'employees',
        in: 'query',
        required: true,
        schema: {
          type: 'array',
          items: {
            $ref: '#/components/schemas/Person',
          },
        },
      },
    ],
    responses: {
      '200': {
        description: '',
      },
    },
    tags: ['booking'],
  },
}

但是现在我正在将重复的查询定义混入一个。有没有办法防止或覆盖@Query定义？或者只是定义复杂@Query的更好方法？

Answer 1

最终创建了一个自定义的装饰器来提取查询，而没有生成OpenAPI规范。

export const SilentQuery = createParamDecorator(
  (data: string | undefined, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest()
    if (data) {
      return request.query[data]
    } else {
      return request.query
    }
  },
)

所以现在可以使用带有deepObject样式的@ApiQuery了。

例如，如果您将ValidationPipes与类验证器一起使用。确保将validateCustomDecorator设置为true

@SilentQuery(new ValidationPipe({ validateCustomDecorators: true }))