修改在Nestjs中的Openapi（Swagger）架构中出现的DTO名称

Question

我面临着一个问题，即我的DTO类型被命名为一件事，但我希望它们在OpenAPI DOC页面中以其他名称出现。 例如，我有一个在控制器中使用的UserDTO类，但希望它在模式部分中简单地显示为“用户”（以及其他任何地方都适用）。有可能吗？我可以使用任何装饰器吗？ 我知道我可以简单地修改类名，但是在其他地方已经使用了其他不同的用户类。 我到处搜索，无济于事。

顺便说一句，我正在使用Typescript和Nestjs。 每个帮助将不胜感激，谢谢！

Answer 1

开箱即用，Nest.js尚未提供现成的解决方案。有一个打开的拉请求（如前所述） https://github.com/nestjs/nestjs/swagger/拉/983 ，但是何时合并是未知的。
您可以使用以下方法之一在模式中更改DTO名称：

1. 在DTO中添加静态名称属性。

  class UserDto {
    static name = 'User';  // <- here

    @ApiProperty()
    firstName: string;

    // ...
  }

但是在严格的模式下，打字稿将显示一个错误：
属性'名称'与内置属性'函数相冲突。

2. 静态 .com/nestjs/swagger/pull/983“ rel =“ noreferrer”>拉请求并使用它，直到所需功能出现在nest.js中。
装饰器将其属性添加到DTO的包装类别中所需值的名称属性。

  type Constructor<T = object> = new(...args: any[]) => T;
  type Wrapper<T = object> = { new(): (T & any), prototype: T };
  type DecoratorOptions = { name: string };
  type ApiSchemaDecorator = <T extends Constructor>(options: DecoratorOptions) => (constructor: T) => Wrapper<T>;

  const ApiSchema: ApiSchemaDecorator = ({ name }) => {
    return (constructor) => {
      const wrapper = class extends constructor { };
      Object.defineProperty(wrapper, 'name', {
        value: name,
        writable: false,
      });
      return wrapper;
    }
  }

如

  @ApiSchema({ name: 'User' }) // <- here
  class UserDto {
    @ApiProperty()
    firstName: string;

    // ...
  }

。将更改为JavaScript

Answer 2

使用apischema装饰器：

@ApiSchema({ name: 'User' })
class UserDto {

  @ApiProperty()
  firstName: string;

  // ...
}

Answer 3

我在我的情况下使用@apimodel

这样解决了

    @ApiModel(value="MeuLindoDto")
    public class NameOriginalClassResponseDto ...