spring-restdocs - 通过 spring-rest-docs 构建 swagger2 规范

Question

我喜欢使用 spring-rest-docs 记录你的 restful api 的 TDD 方法。但是，我喜欢 swagger 规范启用的“API Playground”功能。我希望有一种方法可以两全其美。

有没有办法从 spring rest docs 构建 swagger2 规范？可能是通过构建自定义请求/响应预处理器。

你有什么想法或建议吗？

Answer 1

目前在 Spring REST Docs 中没有开箱即用的支持。您打开的问题将跟踪添加此类功能的可能性。同时，您最好的选择是编写一个自定义Snippet实现来生成（部分）Swagger 规范。

通常，Spring REST Docs 片段处理记录单个资源，而 Swagger 规范描述整个服务。这意味着 Swagger 规范Snippet实现需要以某种方式累积状态，然后才能最终生成完整的规范。有很多方法可以做到这一点（在内存中，在后处理步骤中组合的多个文件等）。我不清楚一种方法显然是正确的，所以一些实验会很有用。如果你做了一些实验，请评论你用你的发现打开的问题。