时间戳

首页 > 解决方案 > 使用 Springfox 在 Swagger UI 文档中添加 Cookie 参数

spring - 使用 Springfox 在 Swagger UI 文档中添加 Cookie 参数

问题描述

我想在 Swagger UI 上添加一个@ApiImplicitParam Springfox 注释来记录服务所需的cookie

@GetMapping(value = "cookies")
public void methodA(
  @RequestHeader HttpHeaders headers) {
    service.checkCookie(headers);  
}

我会尝试做

@GetMapping(value = "cookies")
public void methodA(
  @ApiImplicitParam(name="cookie", paramType = "header", type = "string") @RequestHeader HttpHeaders headers) {
    service.checkCookie(headers);  
}

但是在 Swagger UI 中，当我按下执行按钮时，不会发送任何 cookie。

开发者工具

Cookie 未发送，并返回错误请求 400代码。但如果我执行打印的 curl，我会获得 OK 状态。

curl -k -i -X GET "https://localhost:8080/cookies" -H "cookie: KEY=VALUE"

HTTP/1.1 200

还可以尝试使用paramType注释值cookie，如下所示：

@GetMapping(value = "cookies")
public void methodA(
  @ApiImplicitParam(name="cookie", paramType = "cookie", type = "string") @RequestHeader HttpHeaders headers) {
    service.checkCookie(headers);  
}

有同样的 400 错误

标签： springcookiesswaggerswagger-uispringfox

解决方案

推荐阅读