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

Build swagger2 specs via spring-rest-docs

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

有没有办法从 spring rest 文档构建 swagger2 规范?可能是通过构建自定义 request/response 预处理器。

您有什么想法或建议吗?

目前 Spring REST 文档中没有对此的现成支持。 issue that you opened 将跟踪添加此类功能的可能性。与此同时,最好的办法是考虑编写一个自定义 Snippet 实现来生成(部分)Swagger 规范。

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