使用Spring REST Docs生成Swagger客户端

时间:2017-03-15 15:38:19

标签: spring-boot swagger swagger-ui spring-restdocs

我已经看过这个Spring REST文档 - video

我们正在进行Spring启动项目,并使用springfox库生成Swagger-ui和swagger文档,如here所述

我们喜欢Spring Rest文档可以用来生成REST API文档,以及我们不需要在我们的Controller代码中添加像@ApiResponse或@ApiOperation这样的swagger注释。此外,文档现在与代码一起使用。

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

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

2 个答案:

答案 0 :(得分:1)

该项目从Spring REST Docs生成OpenAPI规范。

https://github.com/ePages-de/restdocs-api-spec

答案 1 :(得分:0)

这直接违背了Spring REST Docs的设计理念和意图。其中一个主要目标是文档与单元测试相关联,因此即使您在REST合同中进行逻辑或签名更改,您也知道您的文档非常可靠。

此外,您链接的视频提供了一些自动文档生成如何产生大量不良预期输出的示例。

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