Làm cách nào để quản lý nhiều tệp lược đồ JSON?

Question

Tôi đang cố gắng xác thực API JSON của mình bằng cách sử dụng node.js + json-schema.js từ commonjs-utils. Chỉ cần xác nhận một lần là dễ dàng nhưng không thể tìm được cách đúng đắn để quản lý nhiều tệp lược đồ để cho phép tham chiếu lẫn nhau.

Giả sử tôi có hai Mô hình & hai API.

// book 
{ 
    "type": "object", 
    "properties": { 
     "title": { "type": "string" }, 
     "author": { "type": "string" } 
    } 
} 
// author 
{ 
    "type": "object", 
    "properties": { 
     "first_name": { "type": "string" }, 
     "last_name": { "type": "string" } 
    } 
} 
// authors API 
{ 
    "type": "array", 
    "items": { "$ref": "author" } 
} 
// books API: list of books written by same author 
{ 
    "type": "object", 
    "properties": { 
    "author": { "$ref": "author" } 
    "books": { "type": "array", "items": { "$ref": "book" } } 
    } 
} 

Mỗi lược đồ phải được chia thành tệp riêng và trực tuyến? Hoặc tôi có thể kết hợp thành tệp lược đồ duy nhất như dưới đây không? Nếu có thể, làm thế nào tôi có thể tham khảo lược đồ cục bộ?

// single schema file { 
    "book": { ... }, 
    "author": { ... }, 
    "authors": { ... }, 
    "books": { ... } } 

Answer 1

Trong JSON Schemas, bạn có thể đặt một sơ đồ cho mỗi tập tin và sau đó truy cập chúng bằng URL của họ (nơi bạn lưu trữ chúng), hoặc một sơ đồ lớn với id thẻ.

Đây là một tập tin lớn:

{ 
    "id": "#root", 
    "properties": { 
     "author": { 
      "id": "#author", 
      "properties": { 
       "first_name": { 
        "type": "string" 
       }, 
       "last_name": { 
        "type": "string" 
       } 
      }, 
      "type": "object" 
     }, 
     // author 
     "author_api": { 
      "id": "#author_api", 
      "items": { 
       "$ref": "author" 
      }, 
      "type": "array" 
     }, 
     // authors API 
     "book": { 
      "id": "#book", 
      "properties": { 
       "author": { 
        "type": "string" 
       }, 
       "title": { 
        "type": "string" 
       } 
      }, 
      "type": "object" 
     }, 
     // books API: list of books written by same author 
     "books_api": { 
      "id": "#books_api", 
      "properties": { 
       "author": { 
        "$ref": "author" 
       }, 
       "books": { 
        "items": { 
         "$ref": "book" 
        }, 
        "type": "array" 
       } 
      }, 
      "type": "object" 
     } 
    } 
} 

Sau đó bạn có thể tham khảo validator của bạn với một trong những schemas phụ (được định nghĩa với một id).

Từ bên ngoài của giản đồ của bạn, điều này:

{ "$ref": "url://to/your/schema#root/properties/book" } 

tương đương với điều này:

{ "$ref": "url://to/your/schema#book" } 

& hellip; đó là tương đương, từ bên trong, như thế này:

{ "$ref": "#root/properties/book" } 

hay này (vẫn từ bên trong):

{ "$ref": "#book" } 

Xem answer here tôi để biết thêm thông tin.