SuperAPI AI 工具集

api-architecture

编程与开发

查看项目

更新于 10-16 05:05

技能介绍

用途:该技能聚焦适用于各类 API 的生产级架构关注点,帮助在规划阶段统一处理版本管理、安全、限流、监控、错误处理、缓存与文档。

主要能力: 版本管理:URL 版本(/api/v1/users、/api/v2/users,推荐)、Header 版本(Accept: application/vnd.api+json; version=2)、查询参数版本(GET /api/users?version=2)。 安全:Bearer Token(JWT,Authorization: Bearer ...;401 表示缺失或无效令牌,403 表示权限不足)、API Key(X-API-Key)、RBAC/ABAC/基于作用域的 OAuth 2.0 权限、边界输入校验(Pydantic、JSON Schema)、防注入与文件上传校验。 限流:提供 RateLimiter 类示例,按调用数与周期检查;响应头 X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset;超限返回 429 与 Retry-After。 监控:健康检查端点 /health 与 /health/detailed;结构化 JSON 日志、请求 ID 追踪;指标包括各端点请求数、延迟、错误率、活跃连接、限流使用量。 缓存:HTTP 缓存(Cache-Control、ETag/If-None-Match 与 304)、服务端缓存(Redis、数据库查询缓存、响应缓存)及失效策略。 错误处理:统一错误格式(code、message、details、timestamp、path);状态码规范 2xx(200/201/204)、4xx(400/401/403/404/422/429)、5xx(500/503)。 文档:OpenAPI/Swagger(FastAPI 的 docs_url、redoc_url)、GraphQL introspection 与 @deprecated。

使用方式:在规划 API 时按上述维度逐项设计,并结合 rest-api-design、graphql-api-design、api-testing 等技能。

限制:资料未提供具体收费、平台支持范围或实施效果数据;示例代码为示意,需按实际技术栈调整。