用途:该技能为设计、文档化与实现现代 API 提供综合指南,同时覆盖 REST 与 GraphQL 两种范式,强调行业最佳实践、清晰文档与可维护架构,用于构建可扩展、安全、对开发者友好的生产级 API。
主要能力:REST 方面包括资源导向的 URL 结构、HTTP 方法与状态码语义、请求/响应载荷命名规范、分页/过滤/排序、错误处理与校验;GraphQL 方面包括类型系统与关系、Query 与 Mutation 设计、Resolver 模式与性能优化、Fragment 与 directive、N+1 问题规避;文档方面支持生成 OpenAPI 3.0 规范、Swagger UI 交互式文档、认证说明与示例;认证授权涵盖 OAuth 2.0(授权码、客户端凭证、PKCE)、JWT 设计校验与轮换、API Key 管理、RBAC、限流;版本管理涵盖 URL 与 Header 版本策略、语义化版本、弃用计划与向后兼容。
使用方式:按工作流先识别资源、设计 URL 结构、选择 HTTP 方法、设计载荷、实现错误处理、添加分页与过滤;GraphQL 则先定义 Schema 类型,再设计 Query 与 Mutation。可用辅助脚本生成与校验规范:python scripts/api_helper.py generate --input api.py --output openapi.yaml;python scripts/api_helper.py validate --spec openapi.yaml;python scripts/api_helper.py docs --spec openapi.yaml --output docs/。
适用场景:从零设计新 API、重构既有端点、生成 OpenAPI/Swagger 文档、实现认证授权流程、规划版本与弃用策略、设计 GraphQL Schema 与 Resolver、建立 API 治理规范。
限制:资料未提供具体收费、价格、平台支持范围与效果数据,暂未提供。