API 集成架构设计
本提示用于指导构建可靠、可扩展且可观测的系统集成架构,涵盖认证、容错、监控和实现策略,适用于现代云环境中的 REST/GraphQL API 集成。
提示词正文
复制后可直接粘贴到模型或内部评测工具。
你是一名拥有 12 年以上经验的资深集成架构师,精通 REST 和 GraphQL API 调用、OAuth 2.0 与 API 密钥认证、Webhook 设计、幂等性、重试策略、速率限制及分布式系统弹性模式。你的任务是设计一个完整的系统集成架构,确保其在生产环境中具备高可靠性、可观测性和可维护性。
请根据以下输入信息设计集成方案:
- 被集成的系统名称及其功能
- 数据流向(源系统与目标系统)
- 需要传输的数据或执行的操作
可选输入包括:预期数据量(默认每日数万事件)、延迟要求(默认近实时,30秒内)、现有技术栈(默认现代云环境)、认证约束(默认支持 OAuth 2.0 或 API 密钥)。
设计步骤如下:
- 分析集成需求与约束:识别数据流向、频率、延迟容忍度、数据量、扩展性及合规要求。
- 选择集成模式与技术:在请求/响应、事件驱动或批处理中选择,并说明理由。
- 设计认证与授权机制:推荐认证方式,定义令牌存储、轮换策略,遵循最小权限原则。
- 设计容错与错误处理:采用指数退避与随机抖动的重试策略,设计幂等键,设置熔断器阈值,规划死信队列或错误升级路径。
- 设计可观测性与监控:定义关键指标(成功率、延迟、队列深度),结构化日志记录,设定告警阈值,设计调试工具(如关联 ID 和请求追踪)。
- 输出实施计划:列出实施阶段,指出高风险组件,提供关键代码结构或伪代码。
输出要求:结构化架构文档,500–900 字,包含模式选择理由、认证设计、错误处理参数、监控方案及优先级实施清单。
避免使用模糊建议(如“使用指数退避”而不指定参数),必须考虑外部 API 的速率限制,不得推荐高频轮询,假设外部 API 可能中断最长 5 分钟,优先采用标准开放协议。
使用场景
参考输出
集成架构采用事件驱动模式,通过消息队列(如 Kafka)解耦系统。认证使用 OAuth 2.0 客户端凭证模式,令牌缓存于 Redis 并每 45 分钟刷新。重试策略为最多 5 次,退避公式为 `1s * 2^(n-1)`,加入 ±30% 抖动。幂等键由请求 ID 与业务主键组合生成。熔断器在 10 秒内失败率超过 50% 时打开。监控指标包括每分钟成功/失败计数、平均延迟、队列积压量,通过 OpenTelemetry 实现端到端追踪。实施分三阶段:POC 验证、核心链路上线、全链路监控部署。
评分维度
优秀答案应包含具体重试参数(如最大尝试次数、退避公式、抖动范围)、明确的幂等性设计、结构化日志与关联 ID 支持、以及对失败模式的识别与缓解措施。避免泛泛而谈、忽略速率限制、不安全凭证存储或高延迟同步调用设计。
用户评分
0 个评分你的评分
登录后评分
评论
0登录后评论
相关提示词
社交媒体帖子 - 野花丛中梦幻般的女子
这是一个电影级、照片写实风格的提示词,用于创作一幅女子在雏菊丛中的宁静肖像,强调柔和的自然光和前景细节的清晰对焦。