请求Swagger与Spring Data Rest集成中的头设置

Question

我在Spring Boot项目中为Spring Data Rest生成的端点设置了Swagger intgration设置。以下是我在项目中的相关依赖：

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'

其中标头中的accept或content类型应为application / json。如何设置正确的标题？

Answer 1

您可以通过使用@ApiOperation Swagger注释告诉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)
    {
         ...
    }
}

通过这样做，他们将出现在下拉列表中。