规范扩展
尽管 OpenAPI Specification 尝试包含大部分的使用场景,在需要时仍然可以通过附加数据来扩展此规范。
此扩展属性被设计为总是以 "x-"
为前缀的模式字段。
字段名模式 | 类型 | 描述 |
---|
^x- | Any | 允许扩展 OpenAPI Schema。此字段名必须以 x- 开头,比如 x-internal-id 。此字段的值可以是 null 、原始类型、数组或对象。可以包含任意有效的 JSON 格式的值。 |
此扩展可能会也可能不会被当前的工具支持,但是可以请求工具开发者支持此扩展(如果工具是内部或开源的)。