JSON Schema

JSON Schema 是一种词汇表，可用于注释和验证 JSON 文档。它为你的 JSON 数据提供契约，定义结构、数据类型和验证规则。

Apidog 使用 JSON Schema 来定义请求和响应主体结构，从而为你的 API 启用自动验证和文档生成。

外部参考

本页面简要介绍 JSON Schema。有关完整的规范详情、语法和高级功能，请参阅官方 JSON Schema 文档。

什么是 JSON Schema？

JSON Schema 是一个强大的工具，可用于：

根据定义的规则验证 JSON 数据

记录预期的 JSON 结构

基于 schema 定义生成模拟数据

确保 API 请求和响应之间的一致性

为 POST/PUT/PATCH 端点定义请求主体 schema

为所有 HTTP 方法指定响应主体结构

根据预期格式验证传入数据

自动生成模拟响应

创建全面的 API 文档

有关 JSON Schema 语法、验证关键字和高级功能的详细信息，请参阅官方 JSON Schema 规范文档。

从定义基本类型和必填字段的简单 schema 开始，然后根据需要逐步添加验证规则和约束。