SuperAPI AI 工具集

rest-api-design

编程与开发

查看项目

更新于 10-15 16:46

技能介绍

用途:用于设计直观、一致且符合资源导向架构最佳实践的 RESTful API,覆盖新建 API、设计端点结构、定义请求/响应格式、实现版本管理、编写 API 文档及重构既有 API 等场景。

主要能力与要点:资源命名建议使用名词与复数形式,例如 GET /api/users、GET /api/users/123、GET /api/users/123/orders、POST /api/products、DELETE /api/products/456;避免动词式和不一致的命名,如 /api/getUsers、/api/createProduct 或单复数混用。参考指南覆盖资源命名、HTTP 方法与操作、请求示例、查询参数、响应格式、HTTP 状态码、API 版本管理、认证与安全、限流响应头以及 OpenAPI 文档,并附有 Express.js 完整示例。

使用方式与建议做法:命名保持一致,返回恰当状态码,集合提供分页、过滤和排序,为 API 提供版本号,使用 OpenAPI 完整记录文档,使用 HTTPS,实现限流,提供清晰的错误信息,日期采用 ISO 8601 格式。

限制与避免事项:端点名中不要使用动词,错误场景不要返回 200,避免不必要地暴露内部 ID,避免过度嵌套资源(最多两级),不要命名不一致,不要遗漏认证,不要返回敏感数据,不要在未做版本管理的情况下破坏向后兼容性。

收费、价格、平台及具体安装步骤暂未提供。