java - Spring-restdocs:如何制作参数、路径和响应字段代码块

Question

我正在使用 spring-restdocs 生成 API 文档，我希望将所有参数、路径和响应字段 JSON 路径打印为表格内的代码部分(Asciidoc 中的反引号)。

例如，JSON 路径 sprockets.[].widgets.[].contentType 比 sprockets.[].widgets.[].contentType 更难以可变宽度字体读取，以等宽字体打印。

请求参数和路径参数也是如此 - 这些是应该以等宽字体打印的标记。

使用 Spring-restdocs 实现这一目标的最简单方法是什么？

预先感谢您的帮助。

G

Answer 1

我认为 REST 文档应该默认执行此操作。我提出了一个将在 1.1 中修复的问题:https://github.com/spring-projects/spring-restdocs/issues/230 。感谢您的建议。

同时，您可以使用custom snippet templates做您想做的事。例如，要自定义请求字段路径的格式，您需要提供 request-fields.snippet文件在 src/test/resources/org/springframework/restdocs/templates看起来像这样:

|===
|Path|Type|Description

{{#fields}}
|`{{path}}`
|{{type}}
|{{description}}

{{/fields}}
|===

注意 {{path}} 周围的反引号.