Hướng dẫn về Lược đồ JSON
Trước khi chúng ta đi vào Lược đồ JSON, điều quan trọng là phải biết sự khác biệt giữa Lược đồ JSON và JSON.
JSON
JSON là viết tắt của Ký hiệu đối tượng JavaScript và đó là định dạng dữ liệu độc lập với ngôn ngữ mà các API sử dụng để gửi yêu cầu và câu trả lời. JSON rất đơn giản để đọc và viết cho cả người và máy. JSON là một định dạng dựa trên văn bản không bị ràng buộc với ngôn ngữ (Ngôn ngữ độc lập).
Lược đồ JSON
Lược đồ JSON là một công cụ hữu ích để xác minh cấu trúc dữ liệu JSON. Để chỉ định cấu trúc của JSON, hãy sử dụng định dạng dựa trên JSON. Mục đích của nó là để đảm bảo rằng dữ liệu JSON được chấp nhận. Quy ước cho dữ liệu JSON của ứng dụng của chúng tôi có thể được xác định bằng lược đồ.
Có ba phần chính trong đặc tả Lược đồ JSON:
Siêu lược đồ JSON:
Siêu lược đồ JSON là ngôn ngữ Lược đồ JSON có thể được sử dụng để gắn nhãn các tài liệu JSON bằng siêu liên kết và hướng dẫn để xử lý và thay đổi các tài nguyên JSON bên ngoài thông qua các môi trường dựa trên văn bản như HTTP. Nhấp chuột tại đây để tìm hiểu thêm về Siêu lược đồ JSON.
Lõi lược đồ JSON:
Nó là một bộ quy tắc để gắn nhãn và xác thực các tài liệu JSON.
Lõi lược đồ JSON:
- Mô tả định dạng dữ liệu bạn hiện có.
- Xác thực dữ liệu có thể được sử dụng trong thử nghiệm tự động.
- Đảm bảo tính chính xác của dữ liệu khách hàng đưa ra.
- Cung cấp tài liệu có thể đọc được cho cả người và máy.
Xác thực lược đồ JSON:
Quá trình xác thực dựa trên Lược đồ JSON áp đặt các giới hạn đối với cấu trúc của dữ liệu phiên bản. Sau đó, bất kỳ từ khóa nào không xác nhận thông tin, chẳng hạn như siêu dữ liệu mô tả và chỉ dẫn sử dụng, được thêm vào một vị trí thực thể đáp ứng tất cả các ràng buộc đã khai báo.
Công cụ Trình xác thực lược đồ JSON của Newtonsoft là một công cụ bạn có thể sử dụng trực tiếp trong trình duyệt của mình, miễn phí. Bạn có thể sử dụng công cụ này để kiểm tra cấu trúc lược đồ JSON của mình. Trang này chứa các điều khiển và giải thích để giúp bạn bắt đầu. Bằng cách đó, thật dễ dàng để biết cách cải thiện cấu trúc JSON của bạn.
Chúng tôi có thể kiểm tra Đối tượng JSON của mình bằng Công cụ xác thực lược đồ JSON:
Chúng tôi có xác thực độ tuổi (tối thiểu = 20 và tối đa = 40) như trong hình trên. Không có lỗi nào được tìm thấy.
Nó hiển thị lỗi nếu xác thực tuổi được nhập không chính xác.
Việc tạo ra một lược đồ JSON
Hãy xem một ví dụ về Lược đồ JSON để xem chúng ta đang nói về điều gì. Đối tượng JSON cơ bản mô tả danh mục sản phẩm như sau:
Lược đồ JSON của nó có thể được viết như sau:
Lược đồ JSON là một tài liệu JSON và tài liệu đó PHẢI là một đối tượng. Từ khóa là các thành viên/thuộc tính đối tượng được chỉ định bởi Lược đồ JSON. “Từ khóa” trong Lược đồ JSON đề cập đến phần “khóa” của tổ hợp khóa/giá trị trong một đối tượng. Viết Lược đồ JSON liên quan đến việc ánh xạ một “từ khóa” cụ thể tới một giá trị trong một đối tượng đối với hầu hết các phần.
Hãy xem xét kỹ hơn các từ khóa mà chúng tôi đã sử dụng trong ví dụ của mình:
Lược đồ JSON mà lược đồ của tài nguyên tuân theo được ghi lại bởi thuộc tính này. Lược đồ này được viết theo tiêu chuẩn dự thảo v4, như được chỉ định bởi “giản đồ $” từ khóa. Điều này ngăn lược đồ của bạn quay trở lại phiên bản hiện tại, phiên bản này có thể tương thích hoặc không tương thích với phiên bản cũ hơn.
Các "tiêu đề"Và"Mô tả” từ khóa chỉ là giải thích; họ không áp đặt bất kỳ giới hạn nào đối với dữ liệu đang được kiểm tra. Hai từ khóa này mô tả mục đích của giản đồ: nó mô tả một sản phẩm.
Các "kiểu” từ khóa xác định điều kiện biên đầu tiên của dữ liệu JSON của chúng tôi; nó phải là một Đối tượng JSON. Nếu chúng tôi không đặt loại cho tất cả các lược đồ, mã sẽ không hoạt động. Một số loại phổ biến là “số” “Boolean” “số nguyên” “null” “đối tượng” “mảng” “chuỗi”.
Lược đồ JSON được hỗ trợ bởi các thư viện sau:
Ngôn ngữ | Thư viện |
C | Yếu tố WJ |
Python | jschon |
PHP | Mô tả của Json Schema |
JavaScript | ajv |
Go | lược đồ gojson |
Kotlin | Trình xác thực phương tiện |
hồng ngọc | JSONSchemer |
JSON (Cú pháp)
Hãy xem qua cú pháp cơ bản của JSON. Cú pháp JSON là một tập hợp con của cú pháp JavaScript bao gồm các phần tử sau:
- Các cặp tên/giá trị được sử dụng để đại diện cho dữ liệu.
- Các đối tượng được giữ trong dấu ngoặc nhọn và mỗi tên được dẫn đầu bởi dấu ':' (dấu hai chấm), với các cặp giá trị được phân tách bằng dấu “,” (dấu phẩy).
- Các giá trị được phân tách bằng dấu “,” (dấu phẩy) và các mảng được đặt trong dấu ngoặc vuông.
Hai cấu trúc dữ liệu sau được hỗ trợ bởi JSON:
- Danh sách các giá trị được sắp xếp: Nó có thể là một mảng, một danh sách hoặc một vectơ.
- Bộ sưu tập các cặp tên/giá trị: Các ngôn ngữ máy tính khác nhau hỗ trợ Cấu trúc dữ liệu này.
JSON (Đối tượng)
Lược đồ JSON là một đối tượng JSON phác thảo loại và cấu trúc của một đối tượng JSON khác. Một biểu thức đối tượng JavaScript có thể biểu thị một đối tượng JSON trong môi trường thời gian chạy JavaScript. Một số ví dụ về các đối tượng lược đồ hợp lệ như sau:
Schema | Diêm |
{} | bất kỳ giá trị nào |
{loại: 'đối tượng'} | một đối tượng JavaScript |
{loại: 'số'} | một số JavaScript |
{loại: 'chuỗi'} | một chuỗi JavaScript |
Ví dụ:
Tạo một đối tượng mới trống:
var JSON_Obj = {};
Tạo đối tượng mới:
var JSON_Obj = đối tượng mới()
JSON (So sánh với XML)
JSON và XML là các định dạng con người có thể đọc được bằng ngôn ngữ độc lập. Trong các tình huống trong thế giới thực, chúng có thể tạo, đọc và giải mã. Dựa trên các tiêu chí sau, chúng tôi có thể so sánh JSON với XML.
phức tạp
Vì XML phức tạp hơn JSON nên các lập trình viên thích JSON hơn.
Sử dụng mảng
XML được sử dụng để thể hiện dữ liệu có cấu trúc; tuy nhiên, XML không hỗ trợ mảng, nhưng JSON thì có.
Phân tích cú pháp
JSON được diễn giải bằng hàm eval của JavaScript. eval trả về đối tượng được mô tả khi được sử dụng với JSON.
Ví dụ:
JSON | XML |
{ “công ty”: Ferrari, “tên”: “GTS”, “giá”: 404000 } |
Ferrari
GTS
404000
|
Ưu điểm của lược đồ JSON
JSON được thiết kế để chuyển hướng bằng ngôn ngữ mà con người và máy có thể đọc được. Tuy nhiên, nếu không có một số tinh chỉnh, nó có thể không. Lược đồ JSON có lợi thế là làm cho JSON trở nên dễ hiểu hơn đối với cả máy móc và con người.
Việc sử dụng Lược đồ JSON cũng loại bỏ nhu cầu về một số cập nhật phía máy khách. Lập danh sách các mã HTML phổ biến và sau đó triển khai chúng ở phía máy khách là một phương pháp điển hình nhưng không chính xác để xây dựng phía máy khách API ứng dụng. Tuy nhiên, đây không phải là chiến lược tốt nhất vì những thay đổi ở phía máy chủ có thể khiến một số chức năng nhất định gặp trục trặc.
Ưu điểm chính của Lược đồ JSON là khả năng tương thích với nhiều ngôn ngữ lập trình, cũng như tính chính xác và nhất quán của việc xác thực.
Lược đồ JSON hỗ trợ nhiều loại trình duyệt và các hệ điều hành, do đó các ứng dụng được viết bằng JSON không mất nhiều công sức để làm cho tất cả chúng tương thích với trình duyệt. Trong quá trình phát triển, các nhà phát triển xem xét một số trình duyệt, mặc dù JSON đã có sẵn các khả năng.
JSON là cách hiệu quả nhất để chia sẻ dữ liệu ở mọi kích cỡ, bao gồm âm thanh, video và phương tiện khác. Điều này là do JSON lưu trữ dữ liệu trong mảng, giúp truyền dữ liệu dễ dàng hơn. Do đó, JSON là định dạng tệp tốt nhất để phát triển và API trực tuyến.
Khi các API trở nên phổ biến hơn, thật hợp lý khi cho rằng việc xác thực và kiểm tra API sẽ ngày càng trở nên quan trọng. Cũng thực tế khi mong đợi rằng JSON không có khả năng trở nên đơn giản hơn nhiều theo thời gian. Điều này ngụ ý rằng việc có một lược đồ cho dữ liệu của bạn sẽ ngày càng trở nên quan trọng hơn khi thời gian trôi qua. Vì JSON là định dạng tệp tiêu chuẩn để làm việc với API, Lược đồ JSON là một sự thay thế tốt cho những người làm việc với API.
