Как документировать 'requestParameters' как массив

У меня есть служба с полезной нагрузкой JSON множество, например:

[{ message: "one"}, {message: "two"}]

Как я могу документировать это, используя spring-restdocs?

MessageContract contractOne = new MessageContract();
contractOne.setMessage("one");

List list = new ArrayList<>();
list.add(contractOne);

this.webTestClient
                .post().uri("/messages")
                .body(BodyInserters.fromObject(list))
                .exchange().expectStatus().isCreated().expectBody()
                .consumeWith(document("POST messages",
                        requestParameters(
                                parameterWithName("message").description("Massage we should save"),
                        ))
                );

Я получил ошибку:

org.springframework.restdocs.snippet.SnippetException:
Request parameters with the following names were not found in the request:
[message, ...]

Я думаю, что restdocs не видит поля потому что это массив. Как правильно с ним обращаться?

Добавлен:

Ресурс:

@PostMapping
private Mono<ResponseEntity> postMessage(@RequestBody List<MessageContract> contract) {
    return service
            .save(contract)
            .collectList()
            .thenReturn(new ResponseEntity(HttpStatus.CREATED));
}

Можете ли вы поделиться своей реализацией конечной точки и кодом создания списка?

Cristian Colorado 09.03.2019 16:17

@CristianColorado готово

Aleksey Kozel 09.03.2019 16:24

Если вы хотите задокументировать тело запроса, используйте PayloadDocumentation.requestFields.

Andy Wilkinson 10.03.2019 00:02
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
Поднятие тревоги для долго выполняющихся методов в Spring Boot
Поднятие тревоги для долго выполняющихся методов в Spring Boot
Приходилось ли вам сталкиваться с требованиями, в которых вас могли попросить поднять тревогу или выдать ошибку, когда метод Java занимает больше...
Версия Java на основе версии загрузки
Версия Java на основе версии загрузки
Если вы зайдете на официальный сайт Spring Boot , там представлен start.spring.io , который упрощает создание проектов Spring Boot, как показано ниже.
Документирование API с помощью Swagger на Springboot
Документирование API с помощью Swagger на Springboot
В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .
0
3
186
1

Ответы 1

Я только что создал для вас небольшой тест, чтобы показать документацию по массиву с помощью requestFields.fieldWithPath.

Убедитесь, что этот подход работает для вас.

    @Test
    public void documentRequestBodyArray() {
        webTestClient
                .post()
                .uri("/contract")
                .header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
                .syncBody(List.of(new MessageContract("one"), new MessageContract("two")))
                .exchange()
                .expectStatus().isOk()
                .expectBody()
                .consumeWith(document("documentArray",
                        requestFields(
                                fieldWithPath("[]").description("a message array"),
                                fieldWithPath("[].message").description("a message"))));
    }

MessageContract здесь выглядит так:

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class MessageContract {
    private String message;
}

Другие вопросы по теме