1

我遇到了 Nest + Swagger 的问题。当我打开我的招摇文档时，我看到了我期望的所有端点，但有两个问题：

  1. 当我单击一个方法时，它会扩展该控制器的所有方法
  2. post 方法说，No parameters尽管为 body 定义了 DTO

最终我认为问题是：Swagger + Nest 并没有operationId为每种方法创建唯一的。我的理解是，只有operationId当方法不够独特时，它们才会无法获得 unique ：例如，2 个具有相同调用签名的方法。

过去，当我遇到这样的问题时，要么是因为我缺少@ApiTags装饰器，要么是我不小心包含了重复的端点。

总的来说，我感觉好像我错过了配置 Swagger 的一步，或者我没有使用 Fastify 正确设置它。我安装了fastify-swagger，但实际上并没有在任何地方使用它，但是根据Nest 网站上的文档，/api/json当使用 Fastify 时，swagger JSON 的路径应该是适合我的。

没用的东西：

  1. 独特的标注方法@ApiOperation
  2. 将 a 添加addTag到 DocumentBuilder 链
  3. 删除swagger-ui-express和@nestjs/platform-express依赖
  4. 移除所有 Fastify 依赖并切换到 Express 等效

更新：

添加@ApiOperation({ operationId: 'test' })到方法确实可以解决此问题，但我的印象是@nest/swagger自动执行此操作。我的方法不够独特吗？

主要的.ts

async function bootstrap() {
  const app = await NestFactory.create<NestFastifyApplication>(
    AppModule,
    new FastifyAdapter(),
  );
  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true,
      forbidNonWhitelisted: true,
      transform: true,
    }),
  );
  app.useGlobalInterceptors(new ClassSerializerInterceptor(app.get(Reflector))); // allows automatic serialization
  app.enableCors();

  const config = new DocumentBuilder().setTitle('PIM API').build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('docs', app, document);

  await app.listen(process.env.APP_PORT || 3001);
}
bootstrap();

一些控制器

@ApiTags('chat-messages')
@Controller('chat-messages')
export class ChatMessagesController {
  constructor(
    private readonly service: ChatMessagesService,
  ) {}

  @Post()
  create(@Body() createChatMessageDto: CreateChatMessageDto) {
    return this.service.create(createChatMessageDto);
  }

  @Get(':stream_id')
  findByStreamId(@Param('stream_id') streamId: string) {
    return this.service.findByStreamId(streamId);
  }

ChatMessageDto

export class CreateChatMessageDto {
  constructor(partial: Partial<CreateChatMessageDto>) {
    Object.assign(this, partial);
  }

  @IsString()
  value: string;

  @IsRFC3339()
  timestamp: Date;

  @IsNotEmpty()
  streamId: string;
}

大摇大摆的 JSON

{
    "/chat-messages":{
       "post":{
          "operationId":"ChatMessagesController_",
          "parameters":[
             
          ],
          "responses":{
             "201":{
                "description":"",
                "content":{
                   "application/json":{
                      "schema":{
                         "$ref":"#/components/schemas/ChatMessage"
                      }
                   }
                }
             }
          },
          "tags":[
             "chat-messages"
          ]
       }
    },
    "/chat-messages/{stream_id}":{
       "get":{
          "operationId":"ChatMessagesController_",
          "parameters":[
             
          ],
          "responses":{
             "200":{
                "description":"",
                "content":{
                   "application/json":{
                      "schema":{
                         "type":"array",
                         "items":{
                            "$ref":"#/components/schemas/ChatMessage"
                         }
                      }
                   }
                }
             }
          },
          "tags":[
             "chat-messages"
          ]
       }
    }
 }
4

1 回答 1

1

您是否尝试将 @ApiProperty 放入您的 dto ？

像这样：

export class CreateChatMessageDto {
  constructor(partial: Partial<CreateChatMessageDto>) {
    Object.assign(this, partial);
  }
  @ApiProperty()
  @IsString()
  value: string;

  @ApiProperty()
  @IsRFC3339()
  timestamp: Date;

  @ApiProperty()
  @IsNotEmpty()
  streamId: string;
}

这允许 Swagger 查看属性。这是 NestJs 在其文档中推荐的内容，请参见此处

于 2022-01-27T13:25:41.390 回答