Как отформатировать Spring REST Docs в теле ответа с помощью mockMvc - PullRequest
Новая
       19

Как отформатировать Spring REST Docs в теле ответа с помощью mockMvc

0 голосов
/ 30 января 2019

Я пишу свою документацию по API с помощью Spring REST Docs.

Пример кода: 

@Override
public void getById(String urlTemplate, PathParametersSnippet pathParametersSnippet, Object... urlVariables) throws Exception {
    resultActions = mockMvc.perform(get(urlTemplate, urlVariables)
            .principal(principal)
            .contentType(APPLICATION_JSON))
            .andExpect(status().isOk())
            .andDo(print());

    // do..
}

Но проблема в том, что результат теста указывается в одной строке.И понять структуру возвращаемых данных очень сложно.

Пример ответа: 

MockHttpServletResponse:
           Status = 200
    Error message = null
          Headers = {Content-Type=[application/json;charset=UTF-8]}
     Content type = application/json;charset=UTF-8
             Body = {"creator":null,"modifier":null,"modificationTime":null,"creationTime":null,"id":100,"deleted":false,"name":"Name","description":null,"report":[{"creator":"System","modifier":"System","modificationTime":"2019-01-30T14:21:50","creationTime":"2019-01-30T14:21:50","id":1,"name":"Form name","reportType":{"creator":"System","modifier":"System","modificationTime":"2019-01-30T14:21:50","creationTime":"2019-01-30T14:21:50","id":1,"deleted":false,"name":"Raport"},"unmodifiable":true}]}
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

Далее, я генерирую документацию на основе полученного ответа и в документации также неформатированный JSON

Что я делаю не так?Как включить форматирование для json?

Ответы [ 2 ]

0 голосов
/ 30 января 2019

Если у вас нет возможности настроить приложение для получения довольно распечатанных ответов, вы можете попросить REST Docs сделать это за вас до того, как они будут задокументированы.Это описано в разделе Настройка запросов и ответов документации:

Предварительная обработка настраивается путем вызова документа с OperationRequestPreprocessor и / или OperationResponsePreprocessor.Экземпляры могут быть получены с использованием статических методов preprocessRequest и preprocessResponse для Preprocessors.Например: 

this.mockMvc.perform(get("/")).andExpect(status().isOk())
    .andDo(document("index", preprocessRequest(removeHeaders("Foo")), 
            preprocessResponse(prettyPrint())));

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

0 голосов
/ 30 января 2019

Вы можете попробовать получить объект ResultActions из mockMvc, а затем получить объект MockHttpServletResponse.После этого вы можете получить все значения полей, которые пришли в ответ.В этом случае вам не нужно будет анализировать строку. 

resultActions = mockMvc.perform(get(urlTemplate, urlVariables)
    .principal(principal)
    .contentType(APPLICATION_JSON))
    .andExpect(status().isOk())
    .andDo(print());

MockHttpServletResponse content = resultActions.andReturn().getResponse();

Также вы можете преобразовать MockHttpServletResponse данные объекта в json.Если вы используете Jacson, то напишите свой собственный сериализатор для этого объекта, добавьте его в MockHttpServletResponse и зарегистрируйтесь в ObjectMapper. 

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(MockHttpServletResponse.class, CustomSerializer.class);
mapper.registerModule(module);
String jsonResult = mapper.writeValueAsString(content);

CustomSerializer должен расширять StdSerializer<MockHttpServletResponse> и переопределять serialize метод.

...