时间戳

首页 > 解决方案 > Swagger Open API 自定义标头

swagger - Swagger Open API 自定义标头

问题描述

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

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

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

标签： swagger

解决方案

从描述参数：

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

推荐阅读