设计接口用这Skill理资源

按 REST 最佳实践设计 API:资源命名、HTTP 方法、状态码、版本控制。

rest-api-design 是组织 REST 接口资源与请求约定的 Skill。它按资源命名路径,区分 HTTP 操作,并整理状态码、分页、版本与说明。

用户集合、单个用户和该用户订单是不同对象,名字与层级先保持一致。集合分页还需稳定排序与边界,返回资料应限定范围,地址看起来规范并不说明权限正确。

主文的复数、最多两层嵌套等是设计建议,不是 REST 的全部强制条件。错误状态应说明真实结果,通用错误消息与排查日志也不宜混成一份泄露内部细节。

适合做接口讨论的共同起点。本文未设计或运行真实接口,完整分页、安全与 Express 示例引用未展开;改版本号也不会自动保住兼容,仍需明确调用方契约与迁移方式。

分类:编程开发

来源仓库:aj-geddes/useful-ai-prompts

适合用来做什么

  • 请遵循REST API设计最佳实践为我设计一个用户认证API。
  • 有哪些REST API设计的原则需要遵循?

安装 rest-api-design

npx skills add https://www.iskills.cc/skills/aj-geddes/useful-ai-prompts/rest-api-design/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 rest-api-design 的用途与原始说明

浏览全部 Skill 指南