如何在 Spring REST Docs 中使请求参数成为可选参数答案

【问题标题】：How to make a request parameter optional in Spring REST Docs如何在 Spring REST Docs 中使请求参数成为可选参数
【发布时间】：2015-11-01 00:16:45
【问题描述】：

我知道fieldWithPath() 有optional()，但没有找到如何使parameterWithName() 成为可选。

【问题讨论】：

【解决方案1】：

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

在 Spring REST Docs 1.0 中，您不能通过一流的 API 将请求参数标记为可选。我建议在参数描述符上使用自定义属性的组合，并在必要时在描述符上设置忽略标志，以允许测试在参数不存在的情况下通过。

【讨论】：

只需投入我的 2 美分作为反馈。我非常不同意没有保证有一个可选的列。这是每个领域的关键细节，几乎是所有文档中的内容。我知道添加属性选项，但这需要大量额外的代码，而且通常似乎不起作用。这些属性经常不会出现在生成的 sn-ps 中。
@BrianC 您正在寻找的功能将在 1.1 中推出。我已经相应地更新了我的答案。如果您在添加属性时遇到问题，请open an issue 提供说明问题的测试用例。