这是3。0是否支持在组件中定义标题参数？

Question

我有一个API yaml文件包含3个API，所有API都需要具有相同定义的头参数。我是否知道OAS 3.0是否支持在组件中定义相同的头参数并使用$ref

/service1:
  /post:
    post:
      **parameters:
        - in: header
          name: X-partner**

/service2:
  /post:
    post:
      **parameters:
        - in: header
          name: X-partner**

/service3:
  /post:
    post:
      **parameters:
        - in: header
          name: X-partner**

如何在组件中定义X-partner，以便我不需要复制

Answer 1

是的，您可以在全局组件/参数部分中定义可重用的标头参数（和其他参数类型），并通过使用$ref引用它们。

openapi: 3.0.2
...

components:
  parameters:
    X-partner:
      in: header
      name: X-partner
      schema:
        type: string
      required: true

paths:
  /service1:
    post:
      parameters:
        - $ref: '#/components/parameters/X-partner'