微服务系列 - 转贴: RESTful Service API 设计最佳工程实践和常见问题解决方案
https://www.jianshu.com/p/cf80d644727e 有兴趣的可以读下英文参考文档 http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api RESTful Service API 设计最佳工程实践和常见问题解决方案 前面两篇内容(RESTful Web Service 架构剖析和HTTP Methods 和 RESTful Service API 设计)介绍了 RESTful Service 的基础概念和理论知识,本篇内容打算总结 RESTful Service APIs 设计最佳工程实践和常见问题的解决方案,侧重点是帮助读者更加有效的解决实际工程问题和如何快速设计一套优秀易用的 APIs。 为了有个讨论的标准和设计目标,我们先来定义下一套优秀的的 RESTful APIs 应该是什么样子: 尽可能的遵守有关 WEB 规范和常见约定; 调用接口简单明了,可读性强,没有歧义; 不同 API 风格保持一致,调用规则,传入参数和返回数据有统一的标准; 能够为客户端提供简单灵活的数据访问方式; 有一定的容错性和防止非法参数功能; 高效,安全可靠,容易扩展。 [长文预警]阅读本文可能需要半个小时以上,如果你没有时间从头读到尾,可以先收藏或看看目录,遇到你关注的问题再详细看起。 API