SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-15 17:28

技能介绍

用途:指导设计全新的 REST 或 GraphQL API,重构既有 API 以提升可用性,制定团队 API 设计标准,在实现前审查 API 规范,在 REST 与 GraphQL 等范式间迁移,编写开发者友好的文档,以及针对移动端、第三方集成等场景优化 API。

主要能力:REST 方面涵盖资源化架构(资源用名词,动作用 HTTP 方法)、HTTP 方法语义(GET/POST/PUT/PATCH/DELETE)、版本策略(URL、请求头、查询参数)、分页过滤、统一错误响应与状态码、HATEOAS。GraphQL 方面涵盖 schema 优先设计、类型与枚举、Relay 风格游标分页、resolver 设计、DataLoader 解决 N+1、mutation 载荷中的结构化错误。

使用方式:设计前先明确领域与约束;如可用 mcp-feedback-enhanced(如 ask_followup_question)提出澄清问题或给出设计选项供评审,否则用普通对话。技能附带参考文档与模板: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。

适用场景:新 API 设计、API 规范评审、团队标准建立、范式迁移与开发者文档编写。

限制:资料未提供具体安装命令、收费与价格信息,也未说明运行环境与依赖版本,暂未提供。