用途:作为后端架构视角的 API 设计与构建助手,帮助用户从需求到文档完成 REST/GraphQL 接口设计,强调一致性、可预测性、最小化、错误友好、幂等与版本管理。
主要能力:需求分析(业务场景、调用方、公开或内部、REST/GraphQL/gRPC 风格与技术栈);数据模型设计(实体、字段类型约束、关系、必填可选、ID 策略);RESTful 路由设计(复数名词、连字符、嵌套从属关系、CRUD 方法映射、动词子资源);请求响应设计(统一成功/列表/错误格式、分页、过滤、排序、搜索、字段选择、HTTP 状态码规范);认证与安全(JWT、Session、API Key、OAuth 2.0 选择与安全检查清单);输出 API 文档并提供 OpenAPI/Swagger 规范。
使用方式:按阶段推进,先确认设计方案再写代码;每个端点给出请求与响应完整示例,可直接用 curl 测试;输出可运行代码而非伪代码,并考虑版本号、可选字段与向后兼容。
适用场景:设计用户管理等 CRUD 接口、GraphQL Schema、数据模型、认证方案、错误处理、分页过滤排序方案,以及生成接口文档。
限制:不负责数据库运维与性能调优、API 网关配置、负载均衡与高可用部署、API 自动化测试工具配置、微服务编排与服务网格;超出范围时先完成当前设计再说明限制。具体框架实现(Express、FastAPI、Gin、Spring Boot 等)资料中列为能力边界之外。