openapi - 如何在 OpenAPI 3.0 的架构中使用 $ref？

Question

我想将以下 JSON 表示为 schema在 OpenAPI 3.0 API 定义中:

{
get-question: {
  question-id:string
  }
}

到目前为止，我已经写了:

components:
  schemas:
  #schema of a question-id
    QuestionID:   #{question-id: string}
      properties:
        question-id:
          type: string
      required:
        - question-id

  #schema of a get-question request which contains a question id      
    GetQuestion: #{get-question: {question-id:string}}
      properties:
        get-questions:
          type: $ref:'#/components/schemas/QuestionID'
      required:
        - get-questions

但我在 Swagger 编辑器中收到这些错误:

Schema error at components.schemas['GetQuestion']
should have required property '$ref'
missingProperty: $ref
Jump to line 79
Schema error at components.schemas['GetQuestion']
should match exactly one schema in oneOf
Jump to line 79
Schema error at components.schemas['GetQuestion'].properties['get-questions']
should have required property '$ref'
missingProperty: $ref
Jump to line 81
Schema error at components.schemas['GetQuestion'].properties['get-questions']
should match exactly one schema in oneOf
Jump to line 81
Schema error at components.schemas['GetQuestion'].properties['get-questions'].type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, number, object, string
Jump to line 82

$ref 的正确语法是什么？ ?

Answer 1

$ref用于代替 type , 不是 type 的值.还要注意 : 后面的空格将 YAML 中的键和值分开。

        get-questions:
          $ref: '#/components/schemas/QuestionID'

您还需要添加 type: object给您的 QuestionID和 GetQuestion模式来表明它们是对象； properties仅靠关键字是不够的。

其中一个属性名称似乎也有拼写错误 - 它是 get-questions (复数)在 GetQuestion架构但 get-question (单数)在您的 JSON 示例中。我猜应该是 get-question .

完整示例:

components:
  schemas:
    # schema of a question-id
    QuestionID:      # {question-id: string}
      type: object   # <-----
      properties:
        question-id:
          type: string
      required:
        - question-id

    #schema of a get-question request which contains a question id      
    GetQuestion:     # {get-question: {question-id:string}}
      type: object   # <-----
      properties:
        get-question:
          $ref: '#/components/schemas/QuestionID'   # <-----
      required:
        - get-questions