如何使用allOf制作Swagger示例组件

Question

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        allOf: 
          - $ref: '#/components/examples/J'
          - id: 123

在响应体示例中使用J2：

responses:
  200:
    content:
      application/json:
        examples:
          test:
            $ref: '#/components/examples/J2'

当前结果：

{
  "$ref": "#/components/examples/J",
  "id": 123
}

预期结果

{
  "name": "my name",
  "id": 123
}

相关文档： https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

使用$ref时Swagger模式属性被忽略 - 为什么？

- Ertuğrul Altınboğa

Answer 1

这是不被支持的。

value应该是示例的文字值。因此，value 不支持 allOf 和 $ref。OpenAPI 没有一种方法来合并多个示例组件的值。

- Helen

---

所以，我必须创建另一个组件，仅添加一个元素。 - Ertuğrul Altınboğa

@ErtuğrulAltınboğa 是的。请随意在 OpenAPI 规范存储库中打开增强请求: https://github.com/OAI/OpenAPI-Specification/issues - Helen

Answer 2

你不能在示例级别上进行组合，但可以在路径级别上组合示例。

这是无效的。

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        allOf: 
          - $ref: '#/components/examples/J'
          - id: 123

但是你可以做到这一点

components:
 examples:
    J:
      value:
        name: my name
        
    J2:
      value:
        id: 123

content:
  application/json:
    schema:
      $ref: '#/components/schemas/MyObject'
    examples:
      objectExample:
        allOf :
         - $ref: '#/components/examples/J'
         - $ref: '#/components/examples/J2'

- Nisha Dave

---

这个不起作用。 - Thao Truong

Answer 3

Nisha Dave回应与https://editor-next.swagger.io/合作的问题。

但是有一个警告：

- Jean-Charles