Swagger-UI：将 CSRF-Cookie 添加到所有请求 [重复]

Question

我构建了一个使用 CSRF-Cookie 进行身份验证的 API。现在我想用 OpenAPI/Swagger 记录这个 API。

所有路由都受到验证 CSRF-Token 的中间件的保护，/sanctum/csrf-cookie 除外，它用于最初检索 Token。

因此，我需要 Swagger-UI 在每个请求中包含 cookie。我关注了documentation，但它不起作用。

这是我的 Swagger-Definition 的摘录：

security:
  - cookieAuth: []
paths:
  /sanctum/csrf-cookie:
    get:
      operationId: "getApiToken"
      responses:
        '204':
          description: "successful token retrieval"
          headers:
            Set-Cookie:
              schema:
                type: string
  /login:
    post:
      operationId: "loginUser"
      requestBody:
        content:
          application/json:
            schema:
              type: "object"
              properties:
                username:
                  type: string
                password:
                  type: string

components:
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: XSRF-TOKEN

从我的浏览器网络监视器的屏幕截图中可以看出，login 请求的标头不包含 XSRF-Token。

相比之下，这是我的前端发送的完全相同的请求：

Answer 1

它应该显示在渲染的 swagger 文档右上角的授权（锁定）图标中。 相反，您可以通过添加

将其添加到每个请求中

  security:
   - api_key: []

阻止每个路由定义。在这种情况下，swagger ui 中请求面板左侧的锁定图标应该显示信息。如果您需要将它们视为标头，请确保使用 parameters 块将其添加到路由中。