SuperAPI AI 工具集

integration-spec

数据与分析

查看项目

更新于 10-15 21:08

技能介绍

用途:编写系统间集成规格文档,作为双方系统的契约,覆盖集成总览、认证授权、端点定义、数据模型、错误处理、限流、时序图与测试场景等必要组成。

主要能力:提供集成规格模板(Overview、Authentication & Authorization、Endpoints、Data Models、Error Handling、Rate Limiting、Testing 等章节);给出认证规格示例(Bearer Token/OAuth 2.0 Client Credentials,含 token 端点、请求响应字段、token 刷新阈值与重试、凭证保管与 HTTPS 等安全要求);端点文档标准(请求头、请求体 JSON Schema 约束与示例、201/400/401/409/429 响应);标准错误格式与错误码表(含 HTTP 状态、重试策略与解决建议);Webhook 规格(HMAC-SHA256 签名校验、时间戳防重放、重试计划与事件载荷);限流规格(默认与按端点配额、响应头、超限响应);时序图示例;测试场景(正常路径、校验错误、边界、幂等);沙箱/预发/生产环境配置。

使用方式:依据模板逐节填写,认证、端点、Webhook 等可按给出的 YAML 结构描述;Webhook 校验示例使用 Python 的 hmac、hashlib 实现。

适用场景:需要定义或评审 API 集成、Webhook、事件 schema 与数据流的文档工作。

限制:资料未提供独立安装命令、定价、平台支持与官方许可信息;具体 URL、域名与密钥为占位示例,需替换为实际值。