spring-restdocs 如何从路径参数中删除 table 名称

Question

我正在记录 api 的路径参数。但它会显示一些自动生成的 table 名称。我正在尝试从路径参数中删除 table 名称。我没有成功。

请帮帮我。

Answer 1

如果您只想删除 "Table 2" 部分 table 字幕，您可以尝试添加带有空标题的字幕块。例如：

[caption=]
./v1/residences/{id}
include::{snippets}/index/request-parameters.adoc[]

Answer 2

您必须 customize 路径参数片段：

在您的项目中添加新的代码片段模板src/test/resources/org/springframework/restdocs/templates/asciidoctor/path-parameters.snippet
模板内容：

+{{path}}+
|===
|Parameter|Description

{{#parameters}}
|{{#tableCellContent}}`+{{name}}+`{{/tableCellContent}}
|{{#tableCellContent}}{{description}}{{/tableCellContent}}

{{/parameters}}
|===

Answer 3

最好的方法是结合@jmformenti 和@alek 的答案：

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

path-parameters.snippet

使用此模板内容：

[caption=]
.{{path}}
|===
|Parameter|Description

{{#parameters}}
|{{#tableCellContent}}`+{{name}}+`{{/tableCellContent}}
|{{#tableCellContent}}{{description}}{{/tableCellContent}}

{{/parameters}}
|===

现在，所有生成的 path-parameters.adoc 文件都将具有正确的内容，您不需要像 Alek 的回答中那样为每个包含添加它。

spring-restdocs 如何从路径参数中删除 table 名称

spring-restdocs How to remove the table name from the path parameters

spring-restdocs