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

Question

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

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

您有任何想法或建议吗？

Answer 1

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

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