Использование скобочной записи Spring RestDocs для документирования объектов массива - PullRequest
Новая
       13

Использование скобочной записи Spring RestDocs для документирования объектов массива

0 голосов
/ 14 ноября 2018

Я использую spring restdocs для документирования моего весеннего загрузочного API с помощью junit / webmvc и столкнулся с проблемой документирования определенной части тела запроса.

Пример тела запроса json: 

{
"thisFieldHas.aDot": {
   "a": "b"
}
...
"thisFieldHas.someDots.andAnArray" : [
   "key" : "someValue"
]
...
}

Теперь я успешно смог документировать thisFieldHas.aDot объект с помощью Spring Rest Doc в скобках , например: 

fieldWithPath("['thisFieldHas.aDot'].a").description("this is the letter a");

однако, у меня не было успеха с thisFieldHas.someDots.andAnArray объектом. Я пробовал приведенные ниже перестановки и у меня нет идей - поддерживает ли Spring Restdocs это? 

fieldWithPath("['thisFieldHas.someDots.andAnArray'].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'].[].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'][].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray'.[]].key").description("this is a key");
fieldWithPath("['thisFieldHas.someDots.andAnArray']['key']").description("this is a key");
...