为了安全且可预测地运行API，必须严格控制接收和返回的数据。我们实施了JSON Schema支持-一种正式的数据结构描述,允许在服务器和客户端自动验证请求和响应。
JSON Schema有助于识别集成阶段的错误，消除不稳定的行为，确保系统之间的互操作性，并提高与API的互操作性。
JSON Schema给出的内容
| 一个机会 | 提供什么 |
|---|---|
| 结构验证 | 确保对象符合预期的字段和类型 |
| 必填字段 | 控制关键属性的存在 |
| 类型化 | 清晰检查数字、行、布尔和数组 |
| 限制和格式 | 支持最小/最大长度,enum,模式,电子邮件格式等。 |
| 重复使用 | 创建模板和重新使用的组件 |
验证如何工作
1.请求或响应与预定义的模式进行比较
2.如果存在偏差-API返回带有解释的错误
3.可以组合、继承、使用条件规则
4.适用于任何级别： 查询、主体、标题、查询参数
对API和客户的好处
防止错误和恶意数据
提高整合稳定性和行为可预测性
基于电路的自动测试和莫克生成
在文档和Swagger/OpenAPI中使用模式的能力
简化API支持和扩展
特别相关的地方
具有外部集成和合作伙伴API的平台
移动和前端应用程序等待明确的响应结构
带有自动API测试的CI/CD pipline
具有动态可变参数和合同的系统