Отображение структуры запросов / ответов API с использованием аннотаций Swagger для Java

Question

Я новичок в Swagger и пытаюсь добавить в API документы пример json ввода / вывода для API с использованием библиотеки аннотаций swagger.io.Я пробовал что-то вроде этого:

@other annotations here
public ResponseObj doSomething(@ApiParam(name = "testname", value = 
"test value", required = true, example = "{\"userId\":\"1234\"}" 
@RequestBody RequestObj req) {
    //some code here
}

В выходной документации я вижу только имя, значение и обязательные поля, а не пример.Я даже пытался

examples = @Example(value = { @ExampleProperty(value = "examplepropvaluetest") } 

, но тоже этого не вижу.

Помогите кому-нибудь?ТИА

Answer 1

Я решил эту проблему с помощью spring-restdocs (https://github.com/spring-projects/spring-restdocs).. По сути, вы генерируете документы при запуске тестов.

Answer 2

Swagger отображает любой запрос / ответ в виде модели (в виде таблицы) и значения примера (json).См. Снимок экрана ниже.

как модель

как пример значения (xml / json)

Нажмите на модель / Пример значения для переключения между ними.