SuperAPI AI 工具集

api-designer

编程与开发

查看项目

更新于 10-15 17:21

技能介绍

用途:指导从零设计或重构 API,涵盖 REST 与 GraphQL 两种范式,并输出生产级 API 设计。主要能力:REST 资源导向端点设计、HTTP 方法与状态码语义、请求/响应负载与命名规范、分页(游标/偏移)、过滤排序、错误处理;GraphQL 类型系统、查询与变更、输入类型、解析器模式、片段与指令、N+1 预防;OpenAPI 3.0 规范生成与 Swagger UI 交互式文档;OAuth 2.0(授权码、客户端凭证、PKCE)、JWT 设计校验轮换、API Key 管理、RBAC、限流;URL 与请求头版本化、语义化版本、弃用与迁移计划。用法:按资源识别、URL 结构、HTTP 方法、负载、错误处理、分页过滤步骤推进;并提供脚本命令用于生成与校验规范,例如 python scripts/api_helper.py generate --input api.py --output openapi.yaml、python scripts/api_helper.py validate --spec openapi.yaml、python scripts/api_helper.py docs --spec openapi.yaml --output docs/。适用场景:新 API 设计、OpenAPI 文档、认证授权流程、版本与弃用规划、GraphQL schema 与解析器、API 治理。限制:资料未提供具体收费、平台依赖与效果保证信息。