如何在OpenAPI 3.0中使用具有不同描述的通用架构?

时间:2019-02-01 18:47:36

标签: swagger openapi

在我看来,这是一个常见的用例,但我无法弄清楚。如果我有一些普遍使用的数据架构,但又希望每个地方都有不同的描述,该怎么办?例如。一个非常简单的例子(我的光年要复杂得多):

components:
  schemas:
    Id:
      type: integer
      minimum: 1
      description: Resource identity (primary key)
    OnOffAuto:
      type: string
      enum:
        - on
        - off
        - auto
    Lights:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/Id'
        status:
          $ref: '#/components/schemas/OnOffAuto'
>>        description: Status of the lights. Value "auto" means they turn on at night and off in the morning.
    Door:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/Id'
        status:
          $ref: '#/components/schemas/OnOffAuto'
>>        description: Status of the door. Value "auto" means it locks at night and unlocks in the morning.

问题是放置OnOffAuto“描述”的位置,因此在每个使用模式引用的地方,它都有一个不同的值。

再一次肯定有一个openapi-3标签会很高兴...它与版本2有很大不同。

0 个答案:

没有答案