cookies - 在 swagger 文档请求中包含 cookie

Question

我的 Web 服务 API 将检查请求中是否包含某个 cookie，但我不知道如何在我的 swagger doc api 调用中包含 cookie。

我尝试了两种方法:

1. 在我的 .yaml 文件中添加 cookie 作为可编辑字段。

   paths:
     /myApi/create:
       parameters:
         - name: Cookie
           in: header
           description: cookie
           required: true
           type: string
   

2. 在swagger ui的html文件中添加

   window.authorizations.add(
       "Cookie",
       new ApiKeyAuthorization("Cookie", 'Name=Val', 'header')
   )
   

但是在这两种方法中我的 api 都没有获取 cookie，我想知道我该如何做到这一点？谢谢!

Answer 1

OpenAPI/Swagger 规范 2.0 不支持 cookie 身份验证。对于下一个版本(3.0)，支持它的讨论可以在下面找到:

https://github.com/OAI/OpenAPI-Specification/issues/15

更新:OpenAPI 规范 3.0 将支持 cookie:https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#parameter-locations