SuperAPI AI 工具集

API Designer

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:设计健壮、可扩展、对开发者友好的 API,覆盖 REST 与 GraphQL 两类接口,适合创建后端 API、定义 API 合约或集成第三方服务时使用。

核心原则:开发者体验优先(清晰可预测的命名、完整文档、有帮助的错误信息、端点间一致模式);从第一天起考虑演进(版本策略、向后兼容、弃用流程、破坏性变更的迁移指南);默认安全(认证授权、限流、输入校验与清洗、仅 HTTPS);性能(高效查询与索引、缓存、大数据集分页、gzip/brotli 压缩)。

REST 设计要点:资源用名词复数与层级路径,如 GET /users、POST /users、GET /users/123/posts;说明各 HTTP 方法的幂等性、安全性与请求/响应体语义;给出 2xx、4xx、5xx 常用状态码含义;统一成功、错误与列表响应格式(含 error.code、details、request_id;分页含 cursor、has_more、total_count 与 links);分页策略对比游标式(推荐,大数据与实时数据)与偏移式(简单、可跳页,但并发写不一致);支持过滤、排序与搜索参数写法;认证方式对比 JWT Bearer、API Key、OAuth 2.0、Basic Auth 的优缺点;限流标准响应头与常见策略;版本策略对比 URL 版本与请求头版本,并给出 v1 起步、仅破坏性变更递增、同时支持 N 与 N-1 等建议。

GraphQL 设计要点:给出 User、PostConnection、PageInfo、Query、Mutation 等 schema 示例;推荐 Relay Connection 分页模式、Mutation 使用 input 类型加 payload、字段级错误处理。另提供 REST 与 GraphQL 的选型建议。

文档与安全:给出 OpenAPI 3.0 片段与文档最佳实践(示例、错误码、认证指南、交互式调试、多语言示例、限流信息、更新日志),以及安全清单(HTTPS、认证授权、输入校验、限流、CORS 白名单、防注入、不在 URL 放敏感数据、审计日志、密钥可轮换撤销)。

限制:资料未提供该技能的安装命令、运行方式、平台要求、收费与价格信息;上述内容为设计规范与建议,不保证具体实现效果。