SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 03:43

技能介绍

用途:辅助设计并实现专业 API,涵盖 REST、GraphQL、gRPC 与 WebSocket 等范式,并处理认证、文档、测试和运维问题。该技能绑定 api-development-agent。

主要能力:分析需求与数据流;按客户端类型和服务场景选择范式(公开/第三方 API 选 REST,复杂数据的移动端选 GraphQL,内部微服务追求高性能选 gRPC,双向实时选 WebSocket);设计面向资源的端点结构;实现认证与授权;生成 OpenAPI 规范;包含限流、HTTP 状态码规范、排错清单与 pytest 测试模板。

使用方式:可直接用自然语言调用,例如“Design a REST API for user management with authentication”“Implement JWT authentication for my FastAPI app”“Generate OpenAPI documentation for my endpoints”。流程为分析需求、选择范式、设计端点、实现安全、生成文档。

示例要点:资料给出 OpenAPI 3.1 的用户管理 API 规范片段;FastAPI 中基于 jose 的 JWT 生成与校验代码(含 SECRET_KEY、ALGORITHM=HS256、30 分钟过期);使用 slowapi 的限流写法,如 @limiter.limit("100/minute");调试可用 curl -H "Authorization: Bearer <token>"。参考文件包括 API_GUIDE.md 与 openapi-template.yaml,外部资源涉及 OpenAPI 规范、REST 最佳实践与 OWASP API 安全。

适用场景:公开或第三方 API、CRUD 服务、移动端数据聚合、内部微服务、实时双向通信,以及需要认证、限流、文档和测试覆盖的 API 项目。

限制:资料未提供该技能的收费、价格、平台支持范围、性能数据或安装命令,这些事实暂未提供;示例中的密钥与配置仅为演示,实际使用需自行替换并评估安全性。