1. JSON Schema

JSON Schema 是一種基于 JSON 的格式，用于描述 JSON 數據的結構和驗證 JSON 數據。它為 JSON 數據提供了一個清晰的描述，可以用來驗證、文檔化，以及界定數據的接口。下面是 JSON Schema 的一些核心特點和應用方式的詳細介紹：

1. 描述數據格式：使用 JSON Schema，你可以詳細描述 JSON 數據的預期結構，包括哪些字段是必需的，字段的數據類型是什么（如字符串、數字、布爾值等），以及字段的其他屬性（如字符串的最小長度、最大長度、正則表達式模式等）。
2. 數據驗證：JSON Schema 最常見的用途之一是驗證 JSON 數據。這意味著你可以根據定義的 schema 來檢查 JSON 數據是否符合預期的格式，這在處理外部數據或 API 響應時尤其有用。如果數據不符合預期，你可以捕獲這些錯誤并相應地處理它們。
3. 自動生成文檔：由于 JSON Schema 以標準化的格式描述了數據的結構，它可以被用來自動生成文檔。這對于 API 的文檔化尤其有用，因為開發者可以清晰地了解 API 接口期望接收什么樣的數據，以及 API 響應將返回什么樣的數據。
4. 簡化開發流程：通過使用 JSON Schema 來驗證數據，開發者可以減少手動編寫用于數據驗證的代碼量。這不僅可以提高開發效率，還可以減少由于數據錯誤導致的 bug。
5. 跨語言支持：JSON Schema 有廣泛的編程語言支持，包括但不限于 JavaScript、Python、Java 和 C#。這意味著無論你使用什么編程語言，你都可以找到庫來幫助你處理 JSON Schema。
6. 版本控制：JSON Schema 本身也在不斷發展，目前有多個版本。每個版本添加了新的功能并對現有功能進行了改進。這使得 JSON Schema 可以適應不斷變化的需求，同時保持向后兼容性。

通過使用 JSON Schema，開發者可以創建更加健壯和可靠的應用程序，確保數據的一致性和準確性，同時提高開發效率和降低維護成本。

2. 誕生背景

JSON Schema 的誕生背景源于對 JSON 數據格式的廣泛采用及隨之而來的需要驗證 JSON 數據結構和內容的需求。JSON（JavaScript Object Notation）是一種輕量級的數據交換格式，易于人閱讀和編寫，同時也易于機器解析和生成。隨著 Web 服務和應用程序接口（API）的快速發展，JSON 成為了在網絡上進行數據交換的一種流行方式。

在這種背景下，開發者和系統架構師面臨著如何有效驗證 JSON 數據的挑戰，特別是在復雜系統和跨團隊合作中，確保數據的一致性和正確性變得尤為重要。以下是 JSON Schema 出現的幾個關鍵背景因素：

1. 數據驗證需求：隨著系統變得越來越依賴于動態和靈活的數據交換，需要一種可靠的方法來驗證數據結構和內容，以防止錯誤數據導致的問題。
2. 自動化和標準化：在自動化處理過程中，如 API 的調用和響應，需要有一個標準方式來描述和驗證數據，從而減少人為干預和潛在的錯誤。
3. 跨語言和跨平臺交互：作為一種與語言無關的數據格式，JSON 被廣泛應用于不同編程語言和平臺之間的交互。JSON Schema 提供了一種統一的方式來定義和驗證數據結構，促進了不同系統之間的互操作性。
4. 文檔和協作：JSON Schema 還可以用作文檔，幫助開發者理解數據模型的結構，促進團隊成員之間的溝通和協作。

因此，JSON Schema 應運而生，它不僅解決了數據驗證的問題，還支持文檔生成、自動化測試和開發工具集成等多種用途，成為了現代 Web 開發中不可或缺的一個組成部分。

3. TS vs JSON Schema

JSON Schema 和 TypeScript（TS）都用于確保數據結構的正確性，但它們在應用和目的上存在一些關鍵區別：

1. 應用范圍：
2. JSON Schema：主要用于描述和驗證 JSON 數據結構，確保 JSON 數據符合預定義的格式。它是獨立于編程語言的，可以用于網絡傳輸中的數據驗證、配置文件的驗證等場景。
3. TypeScript：是 JavaScript 的一個超集，它添加了靜態類型定義的功能。TypeScript 主要用于在編譯時檢查代碼中的類型錯誤，提高開發效率和代碼質量。
4. 執行時機：
5. JSON Schema：通常在運行時用于驗證數據，例如驗證 API 請求/響應的數據結構。
6. TypeScript：在編譯時進行類型檢查，編譯后的代碼轉換為普通的 JavaScript，運行時不會進行類型檢查。
7. 目的和使用場景：
8. JSON Schema：用于確保數據遵守特定的格式和結構，常用于 API 數據交換和配置數據驗證。
9. TypeScript：旨在通過引入靜態類型系統來提高代碼的可維護性和可讀性，主要用于開發階段，幫助開發者捕捉類型相關的錯誤。
10. 語言和平臺：
11. JSON Schema：是一個獨立的規范，可以與任何支持 JSON 的編程語言一起使用。
12. TypeScript：是一種編程語言，需要特定的編譯器（TypeScript 編譯器）將 TypeScript 代碼轉換為 JavaScript 代碼。

JSON Schema 主要關注于運行時的數據驗證，確保數據結構的正確性；而 TypeScript 關注于編譯時的類型檢查，提升開發過程中的代碼質量和安全性。兩者雖然在某些方面具有互補性，但服務于編程和數據處理的不同階段和方面。

4. 示例

4.1 最小示例

{ "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Person", "type": "object", "properties": { "firstName": { "type": "string", "description": "The person's first name." }, "lastName": { "type": "string", "description": "The person's last name." }, "age": { "description": "Age in years which must be equal to or greater than zero.", "type": "integer", "minimum": 0 } }}

數據：

{ "firstName": "John", "lastName": "Doe", "age": 21}

4.2 數組

{ "$id": "https://example.com/arrays.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "A representation of a person, company, organization, or place", "type": "object", "properties": { "fruits": { "type": "array", "items": { "type": "string" } }, "vegetables": { "type": "array", "items": { "$ref": "#/$defs/veggie" } } }, "$defs": { "veggie": { "type": "object", "required": [ "veggieName", "veggieLike" ], "properties": { "veggieName": { "type": "string", "description": "The name of the vegetable." }, "veggieLike": { "type": "boolean", "description": "Do I like this vegetable?" } } } }}

數據：

{ "fruits": [ "apple", "orange", "pear" ], "vegetables": [ { "veggieName": "potato", "veggieLike": true }, { "veggieName": "broccoli", "veggieLike": false } ]}

4.3 枚舉

{ "$id": "https://example.com/enumerated-values.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Enumerated Values", "type": "object", "properties": { "data": { "enum": [42, true, "hello", null, [1, 2, 3]] } }}

數據：

{ "data": [1, 2, 3]}

4.4 正則

{ "$id": "https://example.com/regex-pattern.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Regular Expression Pattern", "type": "object", "properties": { "code": { "type": "string", "pattern": "^[A-Z]{3}-d{3}$" } }}

數據：

{ "code": "ABC-123"}

4.5 嵌套

{ "$id": "https://example.com/complex-object.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Complex Object", "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer", "minimum": 0 }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string", "pattern": "d{5}" } }, "required": ["street", "city", "state", "postalCode"] }, "hobbies": { "type": "array", "items": { "type": "string" } } }, "required": ["name", "age"]}

數據：

{ "name": "John Doe", "age": 25, "address": { "street": "123 Main St", "city": "New York", "state": "NY", "postalCode": "10001" }, "hobbies": ["reading", "running"]}

4.6 條件驗證

{ "$id": "https://example.com/conditional-validation-dependentRequired.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Conditional Validation with dependentRequired", "type": "object", "properties": { "foo": { "type": "boolean" }, "bar": { "type": "string" } }, "dependentRequired": { "foo": ["bar"] }}

{ "$id": "https://example.com/conditional-validation-dependentSchemas.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Conditional Validation with dependentSchemas", "type": "object", "properties": { "foo": { "type": "boolean" }, "propertiesCount": { "type": "integer", "minimum": 0 } }, "dependentSchemas": { "foo": { "required": ["propertiesCount"], "properties": { "propertiesCount": { "minimum": 7 } } } }}

{ "$id": "https://example.com/conditional-validation-if-else.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Conditional Validation with If-Else", "type": "object", "properties": { "isMember": { "type": "boolean" }, "membershipNumber": { "type": "string" } }, "required": ["isMember"], "if": { "properties": { "isMember": { "const": true } } }, "then": { "properties": { "membershipNumber": { "type": "string", "minLength": 10, "maxLength": 10 } } }, "else": { "properties": { "membershipNumber": { "type": "string", "minLength": 15 } } }}

5. 驗證器

JS 可使用 ajv：

// or ESM/TypeScript importimport Ajv from "ajv";// Node.js require:const Ajv = require("ajv");const ajv = new Ajv(); // options can be passed, e.g. {allErrors: true}const schema = { type: "object", properties: { foo: { type: "integer" }, bar: { type: "string" }, }, required: ["foo"], additionalProperties: false,};const data = { foo: 1, bar: "abc",};const validate = ajv.compile(schema);const valid = validate(data);if (!valid) console.log(validate.errors);

其他平臺可參考官網：

來源-微信公眾號:好朋友樂平

出處:https://mp.weixin.qq.com/s/G8RdfUpUjTYWtsFHdLIniw