Java SpringRestDocs：如何生成参数、路径和响应字段代码块

我正在使用SpringRestDocs生成API文档，我希望所有参数、路径和响应字段JSON路径都在表中打印为代码部分（Asciidoc中的backticks）

例如，JSON路径链轮。[].widgets。[].contentType在可变宽度字体中比

链轮。[].widgets。[].contentType

，在monospace中打印更难读取

请求参数和路径参数也是如此——它们是应该在monospace中打印的令牌

使用SpringRestDocs实现这一点的最简单方法是什么

提前感谢您的帮助

---

我认为REST文档在默认情况下应该这样做。我已打开一个问题，该问题将在1.1中修复：。谢谢你的建议

同时，您可以使用。例如，要自定义请求字段路径的格式，需要在

src/test/resources/org/springframework/restdocs/templates

中提供一个

request fields.snippet

文件，如下所示：

|===
|Path|Type|Description

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

{{/fields}}
|===

---

请注意

{{path}}

周围的倒勾。您也可以使用asciidoctor格式代码，例如单空间的“m”：

m|{{path}}

您甚至可以更改列宽和对齐方式，例如三列相对宽度为4-4-2，第三列中心对齐：

[cols="2*4,^2"]
|===
|Parameter|Description|Optional

（我知道这不是您所要求的，但对于新加入asciidoc的anyo spring restdocs用户来说，了解到有许多简单的定制选项可能会有所帮助）

看