大多数程序员写得出来API但写得好不好看命——这个Skill帮你封死那些随手糊的坑

说真的,大部分程序员API 写得出来,但写得好不好看命。

我见过太多这样的项目:接口返回 200 状态码但 body 里塞着 { "error": "用户不存在" };分页用 limit offset 混着 cursor 一起上;错误响应今天 { "msg": "xxx" } 明天变成 { "message": "yyy" }。后端自己都记不住写了啥,前端对接的时候只能靠猜。

今天要推荐的这个 Skill,叫 api-design,来自一个叫 affaan-m/ECC 的大型开发者技能库。它专门解决一件事:怎么把 REST API 写得像正经 API,而不是自己随手糊的玩具。

它到底干了什么

简单说,这个 Skill 封装了一套生产级 REST API 的设计规范,涵盖:

  • 资源命名/users/{id}/orders 还是 /orders?user_id=?什么时候该嵌套、什么时候该平级
  • 状态码:201 还是 202?404 还是 204?读一遍用错率直接降一半
  • 分页:cursor-based vs offset-based 各自适用什么场景,细节拉满
  • 错误响应:统一的 error body 格式,字段名一致、code 和 message 分层
  • 版本控制:URL 版本 vs Header 版本,哪个坑更少
  • 限流:Rate Limiting 的标准响应头怎么配,Retry-After 怎么用

为什么值得装

我最喜欢的部分是它的实战思路:不是教你背规范,而是给你对比方案——为什么 cursor 分页比 offset 好?为什么 API 版本放 URL 里迟早要还债?

这种”设计决策”的思路,才是真正的开发者洞察。你不只是在学怎么写 API,而是在学怎么在写之前就想清楚。

直接用这个命令装:

px skills add https://github.com/affaan-m/ECC --skill api-design

适用场景

  • 正在设计新的 HTTP API,不知道用什么规范
  • 接了别人的烂 API,想对照自己的设计是否正确
  • 带新人,直接甩这个 Skill 让 Claude 给你 code review
  • 写技术文档,需要标准化的 API 描述参考

GitHubhttps://github.com/affaan-m/ECC


GitHub: https://github.com/affaan-m/ECC

评论区

0 条评论

登录后可评论。

江望 11 阅读