Swagger / springfox генерирует пример ответа автоматически - PullRequest
Новая
       11

Swagger / springfox генерирует пример ответа автоматически

0 голосов
/ 04 декабря 2018

В настоящее время с помощью Springfox 2.9.2 для документа Swagger создается API, созданный в Spring.Я хочу добавить пример ответа в документацию, как на этом изображении;

enter image description here

Я понимаю, что могу сделать что-то похожее на это: 

@ApiResponses(value = {
    @ApiResponse(code = 200, message = "Success", 
            examples = @io.swagger.annotations.Example(
                value = {
                    @ExampleProperty(value = "{'snapshot'：{'type': 'AAA'}}", mediaType = "application/json") 
                }))

В этом случае я помещаю этот фрагмент кода чуть выше метода GET.к сожалению, 2 приведенных выше примера всегда показывают: идентификатор ожидаемой ошибки

Но я также вижу, что могу сделать это тоже: 

@ApiResponses(value = {
    ApiResponse(code = 200, message = "Success", response = MyModel.class,
    )
})

Также я вижу, что могу добавить пример с @ApiOperationуровень: 

@ApiOperation(value = "Create a Account", nickname = "createAccount", notes = "Create a account", response = AccountResponse.class, tags={  })

Мои вопросы:

  1. Как добавить пример ответа JSON в мою документацию по Swagger?

  2. Было бы идеально просто указать Swagger / Springfox на мою модель / боб, чтобы он автоматически генерировал пример ответа и автоматически обновлялся при каждом обновлении бина / модели.Это то, что должен делать второй фрагмент кода выше?

...