Настройка заголовка запроса в интеграции Swagger с Spring Data Rest

У меня есть настройка интеграции Swagger для конечных точек, созданных Spring Data Rest в проекте Spring Boot. Ниже приведены связанные зависимости, которые у меня есть в проекте:

compile "io.springfox:springfox-swagger2:2.6.1"
compile "io.springfox:springfox-swagger-ui:2.6.1"
compile "io.springfox:springfox-data-rest:2.6.1"
compile "io.springfox:springfox-bean-validators:2.6.1"

Настройка заголовка в Swagger для этих конечных точек различна. Например, у меня есть

curl -X GET --header 'Accept: application/x-spring-data-compact+json' 'http://localhost:8080/accounts'

где тип принятия или содержимого в заголовке должен быть application/json. Как правильно настроить заголовок?


swagger springfox spring-data-rest
person vic    schedule 27.03.2017    source источник
comment
Разве нет раскрывающегося списка, в котором можно выбрать application/json или application/x-spring-data-compact+json?   -  person Dilip Krishnan    schedule 03.04.2017
comment
Да, есть выпадающий список. Но приложения/json или приложения/‹›+json там нет.   -  person vic    schedule 03.04.2017

Ответы (1)


arrow_upward
0
arrow_downward

Вы можете сообщить Swagger о типах контента, которые могут быть возвращены конечной точкой, используя аннотацию @ApiOperation Swagger. Например;

@ApiOperation(produces = "application/json,application/x-spring-data-compact+json")

Полный пример:

@RestController
class ExampleController
{
    @ApiOperation(produces = "application/json,application/x-spring-data-compact+json")
    @RequestMapping(value = "/byId", method = RequestMethod.GET)
    public ExampleResponse getById(@RequestParam String id)
    {
         ...
    }
}

Сделав это, они появятся в раскрывающемся списке.

person sibenye    schedule 07.09.2017