spring-restdocs - 有没有一种简单的方法可以在 spring-restdocs 中创建单个片段？

Question

我刚刚深入研究了 spring-restdocs，我真的很喜欢记录我的 API 的方式。现在我想用python扩展生成的例子。意味着我想要像 curl 这样的片段，只适用于 python。

这是我到目前为止发现的：

我将不得不创建自己的模板，例如 default-curl-request.snippet。通过org.springframework.restdocs.snippet.TemplatedSnippet扩展我自己的实现是否正确？

Answer 1

如果您想使用模板来生成代码片段，那么您所描述的就是正确的方法。

请注意，您不必使用模板。您可以选择直接实现该Snippet接口，然后您可以使用任何您喜欢的方式自由地生成一个片段。这是来自采用这种方法的第三方扩展的片段实现。