有没有使用Components对象的技巧我可以$ Ref一个经常使用的Description对象?

时间:2017-12-19 18:04:15

标签: openapi

我发现自己在请求者中一次又一次地重复描述>内容。我在OpenAPI v3规范中寻找了一种DRY技术,我可能会使用$ Ref来简化操作。什么都没有跳出来。所以我想我会问这里的专家是否知道方法。

1 个答案:

答案 0 :(得分:1)

它是纯粹的描述重复,还是您的requestBody内容架构的子部分?如果是前者,您可以简单地将模式分解为子模式,并将$ref分解为子模式。如果是后者......

由于description是一个字符串属性而不是一个对象,它不能被$ref替换,但您可以使用allOf schema关键字来组合模式:

allOf:
  - $ref: '#/components/schemas/myDescription'
  - ... # other schema properties

和您的components/schemas

myDescription:
  description: 'Re-usable description here'