用途:该技能聚焦 REST 与 GraphQL API 设计原则,用于设计新接口、重构旧接口、建立团队设计标准、实现前评审规格、在 REST 与 GraphQL 间迁移、编写开发者文档,以及针对移动端或第三方集成做优化。
主要能力:REST 部分涵盖面向资源的架构(资源用名词、动作用 HTTP 方法)、HTTP 方法语义(GET/POST/PUT/PATCH/DELETE)、版本化策略(URL、请求头、查询参数)、分页与过滤、统一错误响应与状态码、HATEOAS。GraphQL 部分涵盖 schema 优先开发、类型与查询/变更/订阅、Relay 风格游标分页、解析器设计、DataLoader 防止 N+1、结构化错误返回。
使用方式:资料提供参考文档(REST 最佳实践、GraphQL schema 设计、版本化策略)、模板(FastAPI REST 模板、GraphQL schema 模板)、评审清单,以及从代码生成 OpenAPI 规格的脚本。示例代码使用 Python、FastAPI、Pydantic、Ariadne、aiodataloader 等。
适用场景:新 API 设计、接口重构、团队规范制定、规格评审、范式迁移、文档编写、特定场景优化。
限制:资料未提供安装命令、收费信息、平台支持范围或实际效果数据;部分示例依赖具体库,需自行确认环境兼容性。