该技能用于指导 REST API 集成的设计与实现,适合构建 API 客户端、接入第三方服务(如 Stripe、Twilio)、实现 webhook 或测试 HTTP 端点,触发词包括 API、REST、integration、webhook、HTTP。流程包括:先阅读 API 文档、确认 base URL 与版本、认证要求、限流配额与错误格式,列出所需端点并规划错误处理;随后选择认证方式,如 API Key(X-API-Key 请求头)、Bearer Token、OAuth 2.0(含令牌刷新与安全存储)或 Basic Auth。客户端实现基于 requests.Session,统一封装请求方法,记录限流响应头,并按状态码区分错误:401 认证失败、403 权限不足、404 资源不存在、429 限流(读取 Retry-After)、5xx 服务端错误。错误处理通过自定义异常(APIError、APIConnectionError、APIAuthenticationError、APIRateLimitError、APIServerError)与重试装饰器实现指数退避。限流方面提供 RateLimiter 控制调用间隔。测试可用脚本 python scripts/test-endpoint.py --url "https://api.example.com/v1/users" --method GET --headers '{"Authorization": "Bearer token"}',并用 pytest 与 mock 编写单元测试。最佳实践包括把密钥放入环境变量、禁止提交凭据、区分环境、记录日志、缓存响应、分页拉取、批次请求、使用 hmac 校验 webhook 签名。常见问题涉及 SSL 证书、超时、大响应流式处理与限流退避。具体库版本、价格与平台支持资料未提供。
api-integration
编程与开发
更新于 10-16 06:17