没有固定属性列表的对象的 Swagger Yaml 架构定义

Question

我正在 Swagger 的帮助下实现一个 API 优先的应用程序。要返回的最重要的对象之一是 DICOM 对象，它返回具有灵活名称的属性集合，例如：

{ 
  "00080005": {"vr":"CS","Value":["ISO_IR 100"]},
  "00080020": {"vr":"DA","Value":["20160602"]},
  "00080030": {"vr":"TM","Value":["171855.7490"]},
  "00080050": {"vr":"SH","Value":["1234"]},
  "00080090": {"vr":"PN","Value":[{"Alphabetic":"Parikh MD^Anush^M"}]}
}

所以我无法提前知道所有属性的名称（00080005、00080030等），虽然文件结构很统一。

我的具体问题是：这种 JSON 文档的架构定义是什么。

我尝试了以下方法但没有成功：

definitions:
  DicomMetadataJson:
    type: object
    patternProperties:
      ^\d{8}:
        type: object      

但 Swagger 编辑器返回如下错误：

代码：“OBJECT_ADDITIONAL_PROPERTIES”

消息：“不允许使用其他属性：patternProperties”

描述：“JSON Schema 对象的确定性版本。”

Answer 1

OpenAPI (fka. Swagger) 仅使用 JSON Schema v4 的一个子集，遗憾的是，它不建议 patternProperties。

但鉴于提供的示例是一张地图，您可以使用 additionalProperties 来描述它：

swagger: "2.0"
info:
  version: 1.0.0
  title: Hashmap

paths: {}

definitions:
  DicomMetadataJson:
    additionalProperties:
      properties:
        vr:
          type: string
        Value:
          type: array
          items:
            type: string

密钥没有定义，应该是一个字符串（因此你不能强制它的格式）。

请注意，SwaggerUI Swagger UI 目前不渲染它们。问题在此处跟踪https://github.com/swagger-api/swagger-ui/issues/1248

与此同时，您可以使用此技巧定义地图对象相同类型的非必需属性（在下面的示例中为默认值），并在描述中给出一些提示：

swagger: "2.0"
info:
  version: 1.0.0
  title: Hashmap

paths: {}

definitions:
  MetaData:
    properties:
      vr:
        type: string
      Value:
        type: array
        items:
          type: string

  DicomMetadataJson:
    description: 'A <string,MetaData> map, default key is only for documentation purpose'
    properties:
      default:
        $ref: '#/definitions/MetaData'
    additionalProperties:
      $ref: '#/definitions/MetaData'

关于报价架构公开了两种类型的字段。具有声明名称的固定字段和声明字段名称的正则表达式模式的模式字段。模式化的字段可以多次出现，只要每个都有一个唯一的名称。，它涉及 OpenAPI 规范本身的格式，而不是 OpenAPI 规范中描述的 API 使用的对象。