Swagger Open API 自定义标头

编程问答 2022-06-01

问题描述

我面临两个与 Swagger 开放 API 相关的问题

  1. 我无法在调用我的 API 时通过 swagger open API 传递自定义标头，请建议我们如何通过 swagger open API 传递自定义标头。

  2. 当我在项目的 pom.xml 上添加 POI 依赖项时，它停止通过 swagger open API 工作，但是，它正在与邮递员一起工作，请提出可能是什么问题。

解决方法

来自Describing Parameters：

API 调用可能需要使用 HTTP 请求发送自定义标头。 OpenAPI 允许您将自定义请求标头定义为 in: header 参数。例如，假设调用 GET /ping 需要 X-Request-ID 标头：

GET /ping HTTP/1.1
Host: example.com
X-Request-ID: 77e1c83b-7bb0-437b-bc50-a7a58e5660ac

使用 OpenAPI 3.0，您可以按如下方式定义此操作：

paths:
  /ping:
    get:
      summary: Checks if the server is alive
      parameters:
        - in: header
          name: X-Request-ID
          schema:
            type: string
            format: uuid
          required: true
swagger