Как использовать Spring restdocs для документирования тела запроса, содержащего объект JSON

Я использую spring boot 2 для реализации службы REST API и хочу задокументировать это с помощью restdocs.

Конечная точка

POST /api/tags

с телом запроса

{"name":"Some Tag", "description":"This is Some Tag"}

используется для добавления создания нового тега. Я просмотрел документацию restdocs, но все еще не могу найти способ задокументировать поля JSON тела запроса. Может ли кто-нибудь помочь мне заполнить недостающую часть «......».

TagRequest request = new TagRequest();
request.setName("Some Tag");
request.setDescription("This is Some Tag");
client.post().uri("/api/tags").body(BodyInserters.fromObject(request)).exchange()
        .expectStatus().isOk().expectBody(Integer.class)
        .consumeWith(document("add-tag", ...... )));

spring-boot spring-restdocs

21.12.2018 10:32

Пользовательский скаляр GraphQL

Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...

Поднятие тревоги для долго выполняющихся методов в Spring Boot

Приходилось ли вам сталкиваться с требованиями, в которых вас могли попросить поднять тревогу или выдать ошибку, когда метод Java занимает больше...

Принятие принципов SOLID в Spring Boot: Создание обслуживаемых и масштабируемых приложений

Запросы к JPA

Версия Java на основе версии загрузки

Если вы зайдете на официальный сайт Spring Boot , там представлен start.spring.io , который упрощает создание проектов Spring Boot, как показано ниже.

Документирование API с помощью Swagger на Springboot

В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .

2 115

Ответы 1

Вам нужен пользователь requestFields

client
                .post().uri("/api/tags")
                .body(BodyInserters.fromObject(request))
                .exchange()
                .expectStatus().isOk()
                .expectBody(Integer.class)
                .consumeWith(
                        document("add-tag",
                                requestFields(
                                        fieldWithPath("name").description("...."),
                                        fieldWithPath("name").description("....")
                                )
                        )
                );

Это задокументировано в официальном документе: https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-request-response-payloads

ответ правильный, конкретно в вашем случае это будет следующим образом: requestFields( fieldWithPath("name").description("some_text").type(String.c‌lass.getSimpleName()‌), fieldWithPath("description").description("some_text").type(S‌tring.class.getSimpl‌eName()) )

— 16.10.2019 15:29

18.01.2019 14:54