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

Question

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

请帮帮我。

Sample Image

Answer 1

您必须customize路径参数片段：

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

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

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

{{/parameters}}
|===

Answer 2

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

1. 在path-parameters.snippet内创建文件src/test/resources/org/springframework/restdocs/templates/asciidoctor/
2. 使用此模板内容：

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

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

{{/parameters}}
|===

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

Answer 3

如果您只想删除表格标题的“表2”部分，可以尝试添加带空标题的标题栏。例如：

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