SuperAPI AI 工具集

hello-api

编程与开发

查看项目

更新于 10-15 22:12

技能介绍

用途:在构建、修改或审查 REST API、GraphQL 端点、webhook、中间件、请求/响应处理、API 版本管理、限流或分页时使用,要求 API 相关代码遵循统一规范。

主要能力与规范:编码前先确定资源模型和端点契约,再写代码。RESTful 设计上,资源命名用复数名词(如 /users,嵌套 /users/:id/posts);HTTP 方法语义为 GET 读、POST 创建、PUT 全量更新、PATCH 部分更新、DELETE 删除;状态码需准确,包括 200、201、204、400、401、403、404、409、422、500。请求验证在 controller 层使用 schema 验证库(zod、joi、ajv),验证类型、范围、格式、必填,并限制文件上传大小与类型、请求体大小。响应格式统一:成功为 { data, meta? },错误为 { error: { code, message, details? } };列表接口必须分页(?page=1&limit=20 或 cursor-based),支持排序(?sort=created_at&order=desc),过滤参数使用白名单。版本与保护方面,API 版本化用 URL 前缀 /v1/ 或 header;按 IP/用户/API key 限流;所有外部调用设超时;CORS 明确允许的 origin,不用 *。

交付检查:状态码准确反映操作结果、所有入参已验证、列表接口有分页、错误响应格式统一、有限流保护。

限制:资料未提供具体安装命令、代码示例、收费或平台信息,暂未提供。