架构参考
全面的架构文档，用于构建 Zapier 集成，包括合适的数据结构、验证规则以及类型定义。
概述
Zapier 平台架构定义了所有集成组件的结构和验证规则。理解这些架构对于构建稳健且可靠的集成至关重要。
架构组件
应用定义架构
- 基本应用元数据：名称、版本、描述和品牌标识
- 身份验证配置：API 密钥、OAuth、会话认证等
- 平台要求：Node.js 版本以及依赖项约束
触发器架构
- 轮询触发器：通过 REST API 端点返回项目列表
- 钩子触发器：用于实时数据的 Webhook 订阅
- 通知 REST 钩子：结合轮询和 Webhook 的混合方式
- 输入字段：用户针对触发器的配置选项
操作架构
- 创建操作：用于创建新记录的 POST 请求
- 更新操作：用于修改现有记录的 PUT/PATCH 请求
- 搜索操作：用于查找特定记录的 GET 请求
- 输入/输出字段：数据映射和验证
搜索架构
- 搜索操作：在您的应用中查找现有记录
- 搜索或创建：整合搜索和创建功能
- 结果处理：处理并格式化搜索结果
字段架构
- 输入字段：面向用户的表单字段，并包含验证
- 输出字段：API 响应数据结构定义
- 字段类型：字符串、整数、布尔值、日期时间、文件等
- 动态字段：基于用户输入在运行时动态生成的字段
验证规则
数据类型
- 字符串验证：长度限制、正则表达式模式以及必需格式
- 数字验证：最小/最大值、整数与浮点数区分
- 布尔值验证：真/假值以及转换规则
- 数组验证：元素类型和长度约束
- 对象验证：嵌套属性的要求
必需与可选
- 必需字段：必须由用户或 API 响应提供
- 可选字段：可以省略而不导致验证错误
- 条件性要求：根据其他字段值而设定的必需字段
自定义验证
- 格式验证：电子邮件、URL、电话号码等模式
- 业务逻辑：针对您应用特定需求的自定义验证规则
- 跨字段验证：依赖多个字段值的验证规则
最佳实践
架构设计
- 使用清晰且描述性的字段名称和标签
- 提供有帮助的描述和示例
- 设置合适的验证规则
- 在设计输入表单时充分考虑用户体验
错误处理
- 定义有意义的错误消息
- 优雅地处理验证失败情况
- 提供修复验证错误的实用指导
性能
- 优化字段定义以实现快速加载
- 审慎使用动态字段
- 缓存高开销的验证操作
请访问 GitHub 文档，获取完整的架构定义、示例以及实施指南。