使用 spring-restdocs 记录数组的每个元素

Question

我有一个 json 数组的响应。每个元素都有它的意义，我可以描述它。

我的阵列：

["1525032694","300","true"]

我在文档中找到了一个描述数组和每个相同元素的示例：

https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-request-response-payloads-fields-reusing-field-descriptors

但我想知道如何将它们描述为：

current timestamp、seconds to next measurement、should perform fota

我目前的测试：

webTestClient.post().uri("/api//measurement/${SampleData.deviceId}")
    .syncBody(SampleData.sampleMeasurement())
    .exchange()
    .expectStatus()
    .isOk
        .expectBody()
        .consumeWith(document("add-measurement", responseFields(
                fieldWithPath("[]")
                        .description("An array of device settings"))
        ))

Answer 1

好的，事实证明这很容易：

        responseFields(
            fieldWithPath("[0]").description("Current timestamp"),
            fieldWithPath("[1]").description("Device mode"),
            fieldWithPath("[2]").description("Device parameter")
        ),

使用 spring-restdocs 记录数组的每个元素

Document each element of an array using spring-restdocs

arrays

json

kotlin

spring-restdocs