别再说”写个API”了,先学会”设计API”

别再说”写个 API”了,先学会”设计 API”

你有没有过这种经历:跟 AI 说”给我写个后端接口”,它唰唰唰给你吐了一堆代码,跑是能跑,但路由乱、字段乱、错误码全凭心情——上线三天就开始怀念当初的自己。

今天给你挖到一个真正有用的开发者 Skill:api-design-principles,来自 wshobson/agents 这个超火的 Claude Code 插件市场仓库。它不教你写代码,它教你在写代码之前,先想清楚 API 长什么样。

这个 Skill 到底能干嘛?

一句话:把 REST / GraphQL API 的最佳实践塞进 AI 的脑子里。

  • RESTful 规范:路径怎么命名、动词怎么选、版本控制放哪
  • GraphQL 设计:Schema 怎么拆分、N+1 问题怎么防、分页策略怎么选
  • 可维护性:错误码体系、字段命名一致性、向后兼容策略
  • 扩展性:怎么设计才能让接口活过三个迭代

说人话就是:以前你让 AI 写接口,它像是个急性子码农——有现成的逻辑就先写,设计?以后再说。装了这个 skill 之后,AI 会先停下来问你:”你的资源边界是什么?要不要版本化?错误码走 RFC 还是自定义?”

谁适合用?

后端工程师、全栈开发者、API 设计师,以及所有”让 AI 帮我写接口但每次都还得自己重写一遍”的人。

特别适合的场景:设计新项目的接口规范、给老 API 做重构方案、写 OpenAPI / GraphQL Schema 文档。装完之后直接跟 Claude Code 说”帮我设计一个用户管理的 API”,出来的东西基本可以直接进 PR。

怎么装?

如果你用 Claude Code,直接 marketplace 安装:

/plugin marketplace add wshobson/agents
/plugin install llm-application-dev

装完就能用,不需要额外配置。也兼容 Codex CLI、Cursor、Gemini CLI 等主流工具。

我的看法

很多开发者对 AI coding 的吐槽集中在”写出来的代码能用但不能用”。这个 skill 恰恰打在痛点上了——接口设计是架构的一部分,不是写完再补的注释。让 AI 在动手之前先做对设计决策,比让它写十遍代码都管用。

仓库地址:https://github.com/wshobson/agents,进去找 llm-application-dev 插件,里面有 api-design-principles skill,94 个插件、175 个 skills,值得逛。


GitHub: https://github.com/wshobson/agents

评论区

0 条评论

登录后可评论。

江望 772 阅读