Spring REST文档询问@RestController?

Spring REST文档询问@RestController?,spring,spring-restdocs,Spring,Spring Restdocs,我正在查看SpringREST文档,想知道它是否能够查询@RestController方法来生成描述RESTAPI的基本文档(方法、http方法、参数、响应类型)?我相信springfoxspring/Swagger可以做到这一点,而且比编写测试来获取基本信息/文档要容易得多 另外,由于我不想在生产环境中运行集成测试,Spring RestDocs方法是否可以在测试环境中运行集成测试,然后将生成的文档/代码片段复制到war中,以便在产品环境中查看?是我的最佳选择。在没有集成测试的情况下,无法使用

我正在查看SpringREST文档,想知道它是否能够查询@RestController方法来生成描述RESTAPI的基本文档(方法、http方法、参数、响应类型)?我相信springfoxspring/Swagger可以做到这一点,而且比编写测试来获取基本信息/文档要容易得多

另外,由于我不想在生产环境中运行集成测试,Spring RestDocs方法是否可以在测试环境中运行集成测试,然后将生成的文档/代码片段复制到war中,以便在产品环境中查看?

是我的最佳选择。在没有集成测试的情况下,无法使用SpringREST文档生成文档。这是一个很好的工具

我正在查看SpringREST文档,想知道它是否能够查询@RestController方法来生成描述RESTAPI的基本文档

SpringREST文档是测试驱动的,故意不采用内省
@RestController
方法。RESTAPI文档描述的是HTTP请求和响应。通过测试驱动和处理真实或模拟的HTTP请求和响应,REST文档确保您正在记录的内容是API用户将要处理的内容

内省
@RestController
方法的问题在于它只是拼图的一小部分。当收到HTTP请求时,它会在到达控制器之前通过过滤器、拦截器、HTTP消息转换等。当发送响应时,反过来也是如此。如果不完全了解控制器调用之前发生的所有事情以及控制器返回后发生的所有事情,文档可能会不准确

springrestdocs方法是在测试环境中运行集成测试,然后将生成的文档/片段复制到war中,以便在Prod环境中查看

对。文档在构建时生成一次,然后通常作为应用程序中的静态文件使用。有关如何使用Spring Boot执行此操作的详细信息,请参阅


这种方法的优点是,创建文档所涉及的所有代码都不会在生产环境中运行。这减少了应用程序的占用空间,避免了生成文档的代码在生产中引起问题的可能性。我相信您可以采用类似的方法使用代码优先的招摇过市工具,但根据我的经验,人们这样做是不寻常的。

谢谢您的回复!