OpenAPI 3 - 重用属性答案

【问题标题】：OpenAPI 3 - Reuse of propertiesOpenAPI 3 - 重用属性
【发布时间】：2019-09-05 04:49:59
【问题描述】：

以 OpenAPI 3 定义为例：

components:
  schemas:
    Foo:
      properties:
        string:
          type: string
        enumField:
          type: string
          enum: ['VALUE_1', 'VALUE_2']
    Bar:
      properties:
        enumField:
          type: string
          enum: ['VALUE_1', 'VALUE_2']

有没有办法重复使用enumField 还是每次使用时都必须指定它？

【问题讨论】：

Property reference to Model on swagger 2.0 (nesting)的可能重复
您需要为该枚举定义一个架构，然后您可以$refenumField 属性中的枚举架构。有关 $ref 语法，请参阅 ^^ 链接问题。
相关：Swagger: Reusing an enum definition as query parameter

标签： swagger openapi

【解决方案1】：

我不知道是否可以引用单个属性，但您可以使用架构并拆分它。

这是一个基本结构示例，说明您可以做什么：

SchemaBase:
  type: object
  properties:
    foo:
      type: string

SchemaFull:
  allOf:
    - $ref: '#/components/schemas/SchemaBase'
    - type: object
      properties:
        bar:
          type: string

在你的情况下可能是这样的：

components:
  schemas:
    EnumField:
      properties:
        enumField:
          type: string
          enum: ['VALUE_1', 'VALUE_2']
    Foo:
      allOf:
        - $ref: '#/components/schemas/EnumField'
        - properties:
            string:
              type: string
    Bar:
      allOf:
        - $ref: '#/components/schemas/EnumField'

【讨论】：