对于生成json以外的内容类型的操作，招摇过市的UI导致HTTP 406不可接受的响应

Question

我有一个与Jersey一起发布的REST API，并用Swagger进行了文档记录，我还有一个使用该API的Swagger UI安装。

我几乎所有的操作都会生成application/json并按预期工作，除了一个GET操作会生成：“text/plain；字符集=utf-8'

当我尝试从Swagger UI调用服务时，服务器会记录一个javax.ws.rs.NotAcceptableException并返回一个406响应。如果我从REST客户端调用相同的服务，它会按预期工作。

@GET
@Path("/text")
@Produces(MediaType.TEXT_PLAIN + ";charset=utf-8")
@ApiOperation(value= "Return text")
public Response getText(@QueryParam("user") String user) {
    return Response.ok(textService.getTextForUser(user)).build();
}

如果我更改为@Produces（MediaType.APPLICATION_JSON"； charset=utf-8"），那么它可以正常工作，但我不想设置错误的内容类型。

问题似乎在于，Swagger UI错误地将Accept标头设置为application/json，通过观察请求可以看出：

GET /supertext/text?user=1
...
Accept: application/json

使用rest客户端时，接受标头是：

GET /supertext/text?user=1
...
Accept: */*

为什么Swagger UI没有正确设置Accept标头？

这个可以配置吗？

Answer 1

我也遇到了同样的问题，但解决方案有所不同。

问题出在一个不相关的控制器上，它的映射没有正确定义。

启动spring boot应用程序时，我可以看到如下日志：

([]) Mapping with class UnrelatedController

每当我加载Swigger UI时，都会发出一个请求Swigger的API，但是会显示对该API的响应，这与Swigger所期望的不匹配。

因此出现错误406

解决方案是纠正UnrelatedController的映射，一切都像以前一样工作。感谢Git历史！

Answer 2

似乎swagger用户界面在发现@Produces注释包含单个值时将接受标头设置为Application/json，否则它会在用户界面中呈现下拉列表以从可用内容类型中进行选择。

在swagger ui中。js公司：

opts.responseContentType = $("div select[name=responseContentType]", $(this.el)).val();

当下拉列表不存在时，属性将变为未定义。

在代码的后面，如果属性为null或未定义，则响应内容类型设置为application/json：

在swagger.js：

if (this.type === "POST" || this.type === "GET" || this.type === "PATCH") {
    if (this.opts.responseContentType) {
      responseContentType = this.opts.responseContentType;
    } else {
      responseContentType = "application/json";
    }
  }

因此，我的解决方案是修改swagger-ui.js中的代码，以确保设置了正确的内容类型，方法是探索生产数组并选择第一个元素作为响应内容类型：

在swagger ui中。js替换线路：

opts.responseContentType = $("div select[name=responseContentType]", $(this.el)).val();

使用：

if($("div select[name=responseContentType]", $(this.el)).val() === undefined) { 
    opts.responseContentType = opts.parent.model.produces[0];
}

else {
    opts.responseContentType = $("div select[name=responseContentType]", $(this.el)).val();
}