可选响应 FieldDescriptor 未按预期工作

问题描述

我在使用 Spring Docs 记录可选响应字段时遇到问题。

我的测试代码：

mockmvc.perform(get("/foo").accept(MediaType.APPLICATION_JSON)) 
        .andExpect(status().isOk()) 
        .andDo(document("foo",responseFields( 
            fieldWithPath("success").description("Indicates request successful or not."),fieldWithPath("message").description("Message.").optional()
        )));

我的回答：

{
  "success" : true
}

错误：

org.springframework.restdocs.payload.FieldTyperequiredException： 无法确定字段“消息”的类型，因为它不存在 在有效载荷中。请提供类型使用 FieldDescriptor.type（对象类型）。

Spring REST Docs 文档说明 (https://docs.spring.io/spring-restdocs/docs/2.0.5.RELEASE/reference/html5/#documenting-your-api-request-response-payloads-fields)

同样，如果在 负载和字段未标记为可选。

那我做错了什么？

解决方法

虽然 df.select(df.url,F.explode(F.from_json(df.json,"array<string>"))) .select("url",F.from_json((F.col("col")),"array<string>").alias("col")) .select("url",F.col("col").getItem(0),F.col("col").getItem(1)) .show(truncate=False) +-------------+-------------+------+ |url |col[0] |col[1]| +-------------+-------------+------+ |https://url.a|1572393600000|1.0 | |https://url.a|1572480000000|1.007 | |https://url.b|1572825600000|1.002 | |https://url.b|1572912000000|1.0 | +-------------+-------------+------+ 字段被标记为可选，但 REST Docs 仍然希望为您记录它。该文档的一部分是字段的类型。响应中缺少该字段，因此 REST Docs 无法自动猜测它。相反，您需要使用 message 方法告诉它：

type