【问题标题】:Swagger Open API Custom headerSwagger Open API 自定义标头
【发布时间】:2020-12-26 03:03:26
【问题描述】:

我遇到了两个与 Swagger 开放 API 相关的问题

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

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

【问题讨论】:

    标签: swagger


    【解决方案1】:

    来自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
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-01-19
      • 2018-05-13
      相关资源
      最近更新 更多