Swagger 招摇过市中同一型号的不同示例

Swagger 招摇过市中同一型号的不同示例,swagger,api-design,swagger-editor,Swagger,Api Design,Swagger Editor,我试图在我的Swagger文件的请求部分创建一个示例。在下面的(高度简化的)片段中,我的请求描述了患者和临床医生之间的关系。这两个实体使用相同的标识符模型 然而,我似乎无法解决如何在仍然使用公共标识符模型的情况下,为患者标识符和临床医生标识符传递不同的示例数据。我发布的代码片段在语法上是正确的,但显然在示例中,两个标识符的数据都是相同的,这远远不够理想 我意识到我可以从Identifer模型中提取字段,然后将它们复制到patientIdentifier和clinicianidentifier中,

我试图在我的Swagger文件的请求部分创建一个示例。在下面的(高度简化的)片段中,我的请求描述了患者和临床医生之间的关系。这两个实体使用相同的
标识符
模型

然而,我似乎无法解决如何在仍然使用公共
标识符
模型的情况下,为
患者标识符
临床医生标识符
传递不同的示例数据。我发布的代码片段在语法上是正确的,但显然在示例中,两个标识符的数据都是相同的,这远远不够理想

我意识到我可以从
Identifer
模型中提取字段,然后将它们复制到
patientIdentifier
clinicianidentifier
中,在这种情况下不需要太多努力,但我想知道是否有更优雅的方法来实现这一点

Relationship:
  properties:
    patientIdentifier:
      $ref: '#/definitions/Identifier'
    clinicianIdentifier:
      $ref: '#/definitions/Identifier'

Identifier:
  type: object
  properties:
    id:
      type: string
      example: "Jane Doe"
    group:
      type: string
      example: "WD7"
如果有人能给我指出一个正确的方向,提供一些文档或者一个这样做的例子,我将不胜感激


谢谢

您需要为
关系提供一个模式级别的示例。架构级示例优先于属性级示例

Relationship:
  type: object
  properties:
    patientIdentifier:
      $ref: '#/definitions/Identifier'
    clinicianIdentifier:
      $ref: '#/definitions/Identifier'
  example:
    patientIdentifier:
      id: Jane Doe
      group: WD7
    clinicianIdentifier:
      id: Bob Smith
      group: ABCDE
请注意,
patientIdentifier
clinicianIdentifier
的属性级别示例将不起作用,因为在使用
$ref
时,
$ref
的任何同级都将被忽略

# This won't work - examples will be ignored

Relationship:
  type: object
  properties:
    patientIdentifier:

      $ref: '#/definitions/Identifier'
      example:
        id: Jane Doe
        group: WD7

    clinicianIdentifier:

      $ref: '#/definitions/Identifier'
      example:
        id: Bob Smith
        group: ABCDE

您需要为
关系
提供架构级别的示例。架构级示例优先于属性级示例

Relationship:
  type: object
  properties:
    patientIdentifier:
      $ref: '#/definitions/Identifier'
    clinicianIdentifier:
      $ref: '#/definitions/Identifier'
  example:
    patientIdentifier:
      id: Jane Doe
      group: WD7
    clinicianIdentifier:
      id: Bob Smith
      group: ABCDE
请注意,
patientIdentifier
clinicianIdentifier
的属性级别示例将不起作用,因为在使用
$ref
时,
$ref
的任何同级都将被忽略

# This won't work - examples will be ignored

Relationship:
  type: object
  properties:
    patientIdentifier:

      $ref: '#/definitions/Identifier'
      example:
        id: Jane Doe
        group: WD7

    clinicianIdentifier:

      $ref: '#/definitions/Identifier'
      example:
        id: Bob Smith
        group: ABCDE

不知道为什么我会被否决票击中-如果有帮助的话,我很乐意改变/添加/删除一些东西-但我不知道我在这里做错了什么。不知道为什么我会被否决票击中-如果有帮助的话,我很乐意改变/添加/删除一些东西-但我不知道我在这里做错了什么。啊哈!没有意识到你可以这么做。这正是我想要的。谢谢:)啊哈!没有意识到你可以这么做。这正是我想要的。谢谢:)