如何在 Nest.js 中制作 Swagger map 未使用的實體？

Question

我有我的 Nest.js 項目，我使用 Prisma 作為 ORM。因此，實際上我不需要使用實體與數據庫通信，但我仍然想使用 Swagger 記錄這些實體。

例如文件user.entity.ts ：

import { Users } from '@prisma/client';
import { ApiProperty } from '@nestjs/swagger';

export class UserEntity implements Users {
  @ApiProperty()
  id: string;
  @ApiProperty()
  firstName: string;
  @ApiProperty()
  lastName: string;
  @ApiProperty()
  ...

即使我導出了這個 class，我也沒有使用它，因為 Prisma 允許這樣做。 問題是雖然它沒有在某處使用（例如@Body裝飾器），但 Swagger 不能 map 這個實體，因此我在我的文檔中看不到它。

有沒有辦法解決這個問題？

Answer 1

好的，這就是它發生的原因。 我找到了關於同一問題的線程。

一般來說，如果您的模型/實體未在某處使用，則無需詳細說明，即使您使用@ApiProperty()對其進行了映射，它也不會顯示在文檔中。

因此，我使用了使用@ApiExtraModels()裝飾器的解決方案並傳遞了所有 DTO。

希望這是有希望的。