带有 multipart/form-data 和 @ApiImplicitBody 的 Swagger 文档

Question

我正在尝试创建一个控制器操作，它必须上传一些文件并将它们与一些字符串一起保存到数据库中。 对于上传文件，我使用FileFieldsInterceptor 和其他数据字符串 DTO。有用。 但我想大摇大摆地记录这个端点，但它不起作用。对于文件，我可以将@ApiImplicitFile 与@ApiConsumes('multipart/form-data') 一起使用，但对于其他正文参数，我尝试使用@ApiImplicitBody 装饰器，应用程序崩溃并在api-parameters.explorer.js 中出现错误。

如何通过@nestjs/swagger 模块将正文参数（文件除外）记录到multipart/form-data 中？

@Post()
@ApiOperation({ ...config.api.post })
@ApiConsumes('multipart/form-data')
@ApiImplicitFile({ name: 'file', required: true, description: 'Infographic file' })
@ApiImplicitFile({ name: 'file_preview', required: true, description: 'Infographic preview file' })
@ApiImplicitBody({ name: 'name', required: true, description: 'Infographic title', type: 'string' })
@UseInterceptors(FileFieldsInterceptor([
        { name: 'file', maxCount: 1 },
        { name: 'file_preview', maxCount: 1 },
    ],
    {
        storage: storageUpload('infographics'),
        limits: {
            fileSize: 20971520, // 20Mb
        },
        fileFilter: (req, file, cb) => {
            const mimeTypeList = ['image/png', 'image/jpeg', 'application/pdf'];

            return mimeTypeList.some(item => item === file.mimetype)
                ? cb(null, true)
                : cb(null, false);
        },
    },
  ), new FilesValidationInterceptor())
upload(@UploadedFiles() files, @Body() createDto: CreateInfographicsDto) {
    return this.infographicsService.create(files, createDto);
}

Answer 1

错误

您必须使用String 而不是'string' 作为类型：

@ApiImplicitBody({ name: 'name', description: 'Infographic title', type: String })
                                                                         ^^^^^^

---

表单数据

根据github issue，@nestjs/swagger 尚不支持记录表单数据参数。已经存在 pull request 可以添加此功能，但尚未合并。您可以订阅它以在状态更新时收到通知。