概述 - Apidog Docs

Schema 是 OpenAPI Specification (OAS) 中的一个基本概念，也通常被称为数据模型。Schema 定义了 API 请求和响应对象的预期数据类型和属性。

JSON Schema 是 Apidog 采用的标准，用于对你的 API 所使用的数据结构进行建模。

借助 Schema，你可以：

定义标准数据结构（例如 Order 对象）。

将 Schema 与自动生成的示例集成。

在你的 API 项目中重复使用数据结构。

Schema 在 Apidog 中的用途

在 Apidog 中，Schema 发挥着关键作用：

用途	描述
设计 API	通过在设计阶段早期定义 Schema，开发者可以可视化并优化其 API 将处理的数据结构。
模拟服务	Apidog 使用已定义的 Schema 生成模拟响应，使开发者即使在实际实现之前，也可以模拟 API 行为和前端交互。
文档	系统会基于 Schema 自动生成准确且全面的 API 文档，便于与 API 使用者清晰沟通预期的数据格式和结构。
调试	Schema 用于在 API 调试中验证响应，确保 API 响应符合已定义的数据模型。

请考虑你的 Schema 的适用范围：这些数据会在多个 API 分区或 API 中使用，还是仅适用于单个用例？

如果该数据结构旨在用于多个场景，创建 Schema 有助于实现集中管理并保持一致性。

你可以在 "Schemas" 目录下添加 Schema。

利用 Apidog 中用户友好的 Schema Editor，可以高效地构建符合 JSON Schema 规范的 Schema。

建立可复用的 Schema 后，请导航到端点，在请求或响应主体中引用这些 Schema，或在其他 Schema 中引用它们。通过引用共享数据模型，你可以保持一致性，并简化该数据模型在 API 设计各个组件中的集成。