本文建议读者：
- 后端工程师、架构师
- 需要跟后端协同的前端工程师
- 以API提供服务的软件提供商
前言
作为一名优秀的后端程序员，你照着产品需求设计好了模型，设计好了关联关系。
把这些模型和关系一再打磨了一番之后，你想是时候把API设计出来，与前端沟通了。
这时候问题来了：
一旦 API 进入前端 APP 代码，或者是被你的顾客广泛使用的话，再来大改就非常麻烦了。比如说，如果 APP 版本 1.0 用了一个接口 A，这个接口 A 如果要进行大改，那么必须将 A 维持至所有用户升级过 APP 1.0 后。
那么怎么样避免 API 发布之后大改呢？有没有一些提前可以注意到的设计准则可以帮我们避开 API 设计中的各种坑？
答案是有的。网上充满了各种对 API 设计的建议，而这篇文章里我们结合卡拉搜索设计 API 的经验，把 REST API 的最佳实践和常见的坑都总结出来，做成一个教程，希望可以在帮到正在设计/使用 API 的你。