用途:该技能帮助开发者掌握 REST 与 GraphQL API 设计原则,构建直观、可扩展、易维护的接口。适用场景包括设计新 REST 或 GraphQL API、重构现有 API 提升可用性、制定团队 API 设计标准、实现前评审 API 规格、在 REST 与 GraphQL 等范式间迁移、编写开发者友好的文档,以及针对移动端或第三方集成优化 API。
主要能力:REST 部分覆盖资源导向架构(资源用名词,动作用 HTTP 方法)、方法语义(GET 幂等安全、POST 创建、PUT 整体替换、PATCH 局部更新、DELETE 删除)、版本策略(URL、请求头、查询参数)、集合设计、分页与过滤(分页参数与分页响应模型)、错误处理与状态码(400/401/403/404/409/422/500 等)、HATEOAS 超媒体链接。GraphQL 部分覆盖 Schema 优先开发、类型与查询/变更/订阅、Relay 风格游标分页、解析器设计、变更输入与载荷类型、DataLoader 批处理防止 N+1 查询。
使用方式:资料未提供该技能的具体安装或调用命令,仅给出参考文件与资源路径,如 references/rest-best-practices.md、references/graphql-schema-design.md、references/api-versioning-strategies.md、assets/rest-api-template.py、assets/graphql-schema-template.graphql、assets/api-design-checklist.md、scripts/openapi-generator.py。资料中示例代码基于 FastAPI、Pydantic、Ariadne、aiodataloader 等,均为示范片段,未提供完整可运行工程。
限制:资料未说明该技能的运行环境、依赖、收费或价格信息;示例代码为教学参考,需结合自身技术栈调整;资料未提供官方发布页或版本更新说明。