API设计的十大最差和五大最佳实践

作者张红月

目前ProgrammableWeb上收录的API数已过8000，这也说明API的火热趋势锐不可当。在2012年，CSDN就做过许多关于API已越来越热的报道，如API趋势锐不可当 收录数同比翻番、开放API正在取代开源软件？，甚至有人提问我们是否正处于API的黄金时代？这似乎也在说明软件已变的越来越开放。

 点击查看PPT（需翻墙）

那么作为开发者，除了要学会调用API外，是否想过设计自己的API呢？这不，国外媒体给大家总结了10条最差API实践与开发API的五个最佳实践，希望各位能在以后的开发道路上少走一些弯路。

十大最差实践

1. 错误处理不完善或者比较差
2. Rest API忽视HTTP规则
3. 暴露原始底层数据模型
4. 安全复杂性
5. 意外和非法发布
6. 缺乏开发经验
7. 期待一个MVC架构带给你一个伟大的API
8. 假设你构建API，用户就会被引进来（Assume if you build it they will come）
9. 技术支持不充分
10. 文档不给力

你们在实际开发中有没有过这些差劲做法呢？说实话，创建一个成功的API并非易事。除了总结错误的做法外，还有没有一些更好地指导原则呢？John Musser在OSCon上提炼了五个观点，在此分享给大家。

五大最佳实践

1. 提供一个有价值的服务器
2. 有一个计划和商务模型
3. 简单灵活
4. 它应该被管理和测量
5. 提供充足的技术支持

在这五个最佳实践里，最重要的是提供一个有价值的服务器，如果你在一台非常糟糕的服务上建立了一套非常伟大的API，那么就相当于给猪涂口红。