Mô hình dao động cho một mảng có các phần tử được đặt tên

Question

Viết mô hình vênh vang cho một mảng json có vẻ khá đơn giản đối với tôi, ví dụ: nếu tôi có mảng này:

[ 
    { 
    "name": "dave", 
    "number": 123 
    }, 
    { 
    "name": "mary", 
    "number": 456 
    } 
] 

Tôi sẽ viết mô hình vênh vang sau cho nó:

"schema": { 
    "type": "array", 
    "items": { 
    "$ref": "Student" 
    } 
} 

"Student": { 
    "id": "Student", 
    "required": [ 
    "name", 
    "number" 
    ], 
    "properties": { 
    "name": { 
     "type": "string" 
    }, 
    "number": { 
     "type": "integer", 
     "format": "int32" 
    } 
    } 
} 

Tuy nhiên, tôi đã điều sau đây:

{ 
    "123": { 
    "name": "dave" 
    }, 
    "456": { 
    "name": "mary" 
    } 
} 

Làm thế nào để viết các mô hình cho cái này?

Xin cảm ơn trước.

Answer 1

Để mô tả mô hình yêu cầu, bạn cần sử dụng thuộc tính additionalProperties. Hãy nhớ rằng, điều này có sẵn trong Swagger 2.0 và không có sẵn trong các phiên bản trước đó.

"definitions": { 
    "Student": { 
     "type": "object", 
     "required": [ "name" ], 
     "properties": { 
      "name": { 
       "type": "string" 
      } 
     } 
    }, 
    "Students": { 
     "type": "object", 
     "additionalProperties": { 
      "$ref": "#/definitions/Student" 
     } 
    } 
} 

Ở trên, bạn thấy mô hình Student, hiện có chứa thuộc tính "tên", mặc dù tôi cho rằng bạn sẽ thêm nhiều hơn vào nó. Từ ví dụ của bạn ở trên, thuộc tính "tên" là bắt buộc.

Mô hình thứ hai là Students là một đối tượng chứa bản đồ (bổ sungProperties). Mỗi thuộc tính là loại Student (được thực hiện bằng cách tham chiếu mô hình, nhưng về mặt lý thuyết có thể đã được xác định nội tuyến).

Điều bạn không thể làm là khai báo rằng khóa (hoặc tên thuộc tính) là một số nguyên hoặc của một kiểu nhất định. Điều đó có thể đã được hỗ trợ với các patternedProperties mà không có sẵn trong Swagger 2.0. Nói cách khác, không có cách nào để hạn chế nội dung của khóa.