OpenApi允许在请求参数中定义cookie。但对于响应,我所能找到的要么是自定义标头(表示Set Cookie的普遍存在,但没有关于特定Cookie的线索),要么是滚动自定义扩展(这也是非常有限的,例如缺乏类型和description
)。
如何定义响应cookie?
OAS在响应中没有提到任何针对cookie的特殊内容。
swagger文档提供了一个如何定义用于身份验证的cookie的示例。但它通常适用于所有类型的cookie。
responses:
'200':
description: >
Successfully authenticated.
The session ID is returned in a cookie named `JSESSIONID`. You need to include this cookie in subsequent requests.
headers:
Set-Cookie:
schema:
type: string
example: JSESSIONID=abcde12345; Path=/; HttpOnly