Документируйте каждый элемент массива, используя spring-restdocs - PullRequest
0 голосов
/ 29 апреля 2018

У меня есть ответ, который является массивом 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"))
        ))

1 Ответ

0 голосов
/ 23 октября 2018

Хорошо, получается довольно просто:

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