如何在Spring REST Docs中创建一个可选的请求参数

Question

我知道fieldWithPath()已optional()，但未找到如何parameterWithName()可选。

Answer 1

在Spring REST Docs 1.1中，您可以mark request and path parameters as optional。如果您希望该信息也出现在生成的表格中，您可以使用添加可选列的自定义代码段（一旦this bug已修复）。

在Spring REST Docs 1.0中，您无法通过一流API将请求参数标记为可选参数。我建议在参数描述符上使用自定义属性的组合，如果需要，在描述符上设置被忽略的标志，以允许测试在参数缺席时传递。