利用Spring Restdocs DSL进行验证

我们的REST API由一组使用Spring Restdocs的测试以标准方式(通过 mockMvc.perform(...)...andDo(document().fieldWithPath(...)) 陈述。由于字段有类型和强制/可选标志,所以我想重用这些信息,以便在生产代码中进行响应体验证。

我把Spring Restdocs移到 compile Maven作用域并将代码段创建移到生产代码中,在生产代码中,src/main代码中的文档化测试和响应体拦截器都可以看到它(后者只调用 ResponseFieldsSnippet.createModel 方法)。除了以下陷阱之外,一切正常:空的对象集合看起来无效,因为框架试图匹配 fieldWithPath 对象字段对不存在数据的规则。

例如,假设cat的JSON描述为 fieldWithPath("kittens[]"), fieldWithPath("kittens[].name") ,实际的JSON {"kittens":[]} 由于不满足后一个描述符,因此显示为无效。对于制造数据的测试样本而言,这种情况不会发生,以最大限度地提高文档效益,但对于实际情况来说却是个问题。

基于这一观察,我倾向于认为重用Restdocs DSL进行验证是一个坏主意。在切换到重量级解决方案la JSON模式之前,我想问:Restdocs是否提供了某种方式将字段描述符表示为树而不是规则列表?例如,上面的 fieldWithPath("kittens[]", subfieldWithPath("name")) . (我认为不管我的情况有多恶劣,这都是有用的。)

我浏览并详细阐述了看起来很有前途的文档中的示例,但AFAIK实际上并没有涵盖这个案例,即:subsectionWithPath(跳过子树)、beneathPath(只关注子树)或 ResponseFieldsSnippet.andWithPrefix (仅用于创建列表的快捷方式,但仍然是列表而不是树)。

谢谢你的意见!