swagger2 с пружинной загрузкой опишите параметр запроса как json - PullRequest
Новая
       22

swagger2 с пружинной загрузкой опишите параметр запроса как json

0 голосов
/ 17 июня 2019

Я использую документацию swagger2 для API в моих службах Rest, мой типичный запрос GET выглядит следующим образом: 

http://localhost:8080/rest/v1/user?request={company:abc, limit: 10, startswith: ABC}

Есть много дополнительных атрибутов внутри запроса json, которые зависят от критериев. Теперь я хочу описать все эти поля для понимания клиента в Swagger-UI. Если я использую @ApiParam, то я не могу описать все параметры в запросе json. Если я использую @ApiImplicitParam, то он не будет частью запроса json во время его выполнения из swagger-ui.

Я попытался с @ApiImplicitParam, как показано ниже, который не работал: 

@ApiImplicitParams({
        @ApiImplicitParam(name = "request", value="request", dataType = "com.mycompany.TestRequest")
    })

Сообщается об одной подобной проблеме, но у нее нет решения. https://github.com/springfox/springfox/issues/2183

Пожалуйста, дайте мне знать, как я могу описать все параметры в запросе json.

...