问题标签 [nestjs-swagger]

我有一个应用程序，我根据 open-api 规范将 API 响应模式定义为纯 javascript 对象。目前我将其传递给ApiResponse@nestjs/swagger 中的装饰器，如下所示：

这很好用。但是，输出的 open-api 规范包含每个使用catSchema. 相反，我希望输出 swagger 文件在该部分下具有 catSchema ，并在路径部分中components有一个对应的部分。$ref

到目前为止，似乎唯一的方法是将模式定义为 DTO 类并ApiProperty为每个类属性使用装饰器。就我而言，这意味着我必须将 open-api 规范中的所有普通对象模式重构为 DTO 类。

有没有办法将原始模式提供给库并获得预期的结果？

对于 API 服务器，我有一组模型，例如

与 TypeORM 中的 ManyToMany 关系。需要在双方模型中定义关系。

在某些路线中，我只显示录音，而在某些路线中，我还使用 leftJoinAndSelect 显示艺术家的录音。例如 /api/artists 和 /api/artists_with_recording。

但是，生成的文档总是在 Artists 中显示 Recordings。

有没有一些简单的方法来修改招摇输出？

我可以使用 swagger 标记制作不同的模型对象，但在更多上下文中使用更多对象可能会变得非常混乱。

我制作了一个 NestJS 微服务包和单独的 NestJS 客户端应用程序，用于联系微服务。下面给出的是客户端应用程序中使用的代码。在微服务中，使用的方法是@messagePattern，它是功能性的。我的问题是前端应用程序如何在不通过客户端的情况下直接与微服务联系，以及如何在微服务中设置 swagger 或直接从邮递员那里进行测试？

这个 SO 答案表明，如果 SwaggerUiapisSorter : "alpha"在实例化时传递，它将按字母顺序对端点进行排序。在 NestJS 中，配置选项在SwaggerModule.createDocument. 我看不到配置中的哪个位置，例如在这里我可以通过它。

我的 NestJS 服务器有一个接受文件和其他表单数据的端点。例如，我在表单中传递了一个文件和文件创建者的 user_id。

NestJS Swagger 需要明确告知 body 包含该文件，并且端点使用multipart/form-data该文件在 NestJS 文档https://docs.nestjs.com/openapi/types-and-parameters#types-and-parameters中没有记录。

我有 2 条路线，一条是 POST，它使用@ApiBody装饰器并正常工作，另一条是 GET，我不知道应该使用什么装饰器来生成正确的 api。

我生成 openapi.json ，@nestjs/swagger然后运行为前端nswag生成文件。api.ts结果是：

所以它有imagesRequestDto: any（为什么？）和一些来自 imagesRequestDto 的解构参数。我想listGet接受相同的参数listPost- 应该有 2 个参数，第一个是query: ImagesRequestDto，第二个是cancelToken。这更方便（尤其是有许多过滤参数），因为这种情况下它可以被

代替

openapi中的get请求是否可以实现或有任何限制？

有人知道从 Swagger 自动生成 NestJS 打字稿代码的方法吗？

nestjs 微服务有什么招摇式的吗？

@nestjs/swagger库只接受普通的nestjs 应用程序，不接受微服务。

我想知道如何将requestInterceptor方法添加到与 Nestjs 一起使用的 Swagger 中？我在任何地方都找不到如何将此属性添加到 SwaggerModule 配置中。这就是我设置招摇文档的方式：

我需要使用 requestInterceptor 的原因是我需要将自定义 'Origin' 标头添加到 Swagger 的“试用”卷曲请求中。使用它的唯一方法是这个 requestInterceptor 属性。

以前有人遇到过这个问题吗？

干杯。

我正在尝试一种从 NestJS 服务器创建 swagger 规范和客户端的简单方法，官方解决方案在这里https://docs.nestjs.com/openapi/introduction。

但是，它需要启动“服务器”，这并不理想，因为某些提供程序需要复杂的设置（例如与 mongo 的连接）。

因此，为了完成任务，不一定需要这种复杂的设置，因此它会是某种理想的TestingModule.stubAllControllerDependencies，这样您就可以生成 swagger 规范。