OpenAPI Swagger 可重用架构部分

Question

我在创建 swagger 可重用架构组件时遇到了一些挑战。

我的项目中有很多 API，其中大多数都有相同的标头和常见的错误响应，当然，每个 API 都有不同的响应模式，为了克服这个挑战，我创建了一个装饰器，如下所示：

swagger-essentials.decorator .ts

type apiOkResponse = Type<unknown>;

export const SwaggerEssentials = (okRes?: apiOkResponse) => {
  return applyDecorators(
    SwaggerApiHeaders(),
    ApiResponse({ type: okRes, status: 200 }),
    HttpCode(200),
    ApiResponse({ type: ConnectTimeoutDTO, status: 599 }),
    ApiResponse({ type: JsonValidationErrorDTO, status: 501 }),
    SwaggerCommonResponses(),
  );
};

response.dto.ts

class Response {
  @ApiProperty()
  id: number;

  @ApiProperty()
  name:string;
}

export class RESPONSE_SCHEMA {
  @ApiProperty({ example: 'Success' })
  message: string;

  @ApiProperty({example: {}})
  data: Response;
}

然后在我的控制器中，我像下面这样使用它：

xyz.controller.ts

@Post('/test')
@SwaggerEssentials(RESPONSE_SCHEMA)
fetchDetails(){}

直到这里一切都很好，没有问题，但是由于每个 API 都有不同的响应，因此有两个属性如果成功响应，消息和数据保持不变，当然数据会不同。

因此，我希望有一些东西可以摆脱上述两个属性，并且它们会自动定义/附加到实际响应。

我已经尝试过 PartialType() 但不值得解决这个问题。

Answer 1

这似乎也是我所面临的事情。但该代码有一些缺点。 RESPONSE_SCHEMA 应该是通用的，可以累积任何类型的数据，它与 Response 类紧密绑定。这可以在泛型的帮助下修复：

export class RESPONSE_SCHEMA <T = any>{
   data: T;
   message : string;
   headers?: Record<string, string>;
}

现在你的控制器函数将返回这个：

@Post('/test')
@SwaggerEssentials(RESPONSE_SCHEMA)
fetchDetails():RESPONSE_SCHEMA<Response>{}

通过这个，你可以在你的 swagger 中获得所需的响应对象。

另外，您可以删除 SwaggerEssentials 中的函数参数并尝试。它应该有效。另外，请重新检查 SwaggerApiHeaders() 和 SwaggerCommonResponses()。这些似乎不是 swagger 模块中的类。