SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 04:59

技能介绍

用途:在创建新 API、重构现有端点或编写 API 规范时,按最佳实践设计 RESTful 与 GraphQL 接口。

主要能力:覆盖从需求定义到文档输出的完整流程。包括识别资源与实体、定义实体关系、规划 CRUD 与自定义操作、设计认证授权、分页过滤排序。REST 设计方面给出资源命名(用名词复数、逻辑嵌套)、HTTP 方法语义(GET 幂等、POST 创建、PUT 全量替换、PATCH 局部更新、DELETE 幂等)、常用响应码(200/201/204/400/401/403/404/409/422/500)、统一错误响应格式与分页响应结构。并提供认证选项(JWT、OAuth 2.0、API Key、Session)、版本策略(URL 版本与 Header 版本)、OpenAPI 3.0 规范示例,以及 GraphQL 作为替代方案的 schema 写法。

使用方式:按步骤推进——先定义需求,再设计 REST 端点,随后确定请求响应格式、错误处理、分页、认证、版本与文档。示例调用形式如 GET /api/v1/users?page=2&limit=20&sort=-created_at&filter=role:admin,认证头形如 Authorization: Bearer <token>。可参考其最佳实践:保持一致性、从一开始就版本化、服务端校验输入、限流、使用 ETag 与 Cache-Control、正确配置 CORS、保持文档同步、充分测试与监控。常见模式包括过滤、排序、字段选择与批量操作。

适用场景:面向 Web/移动端后端接口设计、API 规范编写、接口重构与评审。

限制:资料未提供该技能的具体安装命令、运行环境、支持平台、收费或价格信息,也未给出实际效果数据,这些内容暂未提供。