SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-16 03:13

技能介绍

用途:该技能聚焦 REST 与 GraphQL API 设计原则,用于设计新接口、重构既有接口、制定团队 API 标准、在实现前评审 API 规范、在 REST 与 GraphQL 之间迁移,以及编写开发者友好的 API 文档。

主要能力:REST 方面涵盖资源导向架构(资源用名词、动作用 HTTP 方法)、HTTP 方法语义(GET/POST/PUT/PATCH/DELETE)、分页与过滤、统一错误处理与状态码、HATEOAS。GraphQL 方面涵盖 schema 优先开发、类型与查询/变更/订阅、Relay 风格游标分页、resolver 设计、DataLoader 防止 N+1。还包含 URL、请求头、查询参数三种版本化策略。

使用方式:资料提供 FastAPI 与 Ariadne 的示例代码、schema.graphql 模板、分页与错误响应模型,以及参考文件(rest-best-practices.md、graphql-schema-design.md、api-versioning-strategies.md)、模板(rest-api-template.py、graphql-schema-template.graphql、api-design-checklist.md)和脚本(openapi-generator.py)。具体安装与调用命令暂未提供。

适用场景:移动端或第三方集成优化、团队规范落地、API 评审与迁移。

限制:资料未说明收费、价格、平台支持范围与效果保证;示例依赖 FastAPI、Pydantic、Ariadne、aiodataloader 等库,实际使用需自行确认环境。