spring-boot - 使用 Spring REST Docs 生成 Swagger 客户端

Question

我看过这个 Spring REST Docs -视频

我们正在做 Spring boot 项目，并使用 springfox 库来生成 Swagger-ui 和 swagger 文档，如此处所述

我们喜欢 Spring Rest 文档可以为生成 REST API 文档所做的事情，以及我们不必在 Controller 代码中添加像 @ApiResponse 或 @ApiOperation 这样的大张旗鼓的注释这一事实。而且文档现在与代码一起存在的事实。

但是如果使用 Spring Rest 文档，我们将错过为我们的 API 自动生成的 Swagger-UI（当我们使用 swagger 集成时）。

Spring REST 文档是否可以生成像 Swagger UI 这样的测试 UI。

score 1 · Accepted Answer

这直接违背了 Spring REST Docs 的设计理念和意图。它的主要目标之一是文档与单元测试相关联，因此即使您在 REST 合同中进行逻辑或签名更改，您也知道您的文档是坚如磐石的。

此外，您链接到的视频还提供了许多示例，说明自动文档生成如何产生许多不希望的非预期输出。

因此，可以选择做更多的工作来获得更好的文档，或者选择完全自动化的选项来节省时间并获得可行但质量较低的文档。这是你的首要任务。

score 1 · Accepted Answer

这个项目从 Spring REST Docs 生成一个 OpenAPI 规范。

2 回答 2