Skip to content

Instantly share code, notes, and snippets.

@zyjibmcn
Created April 4, 2016 14:57
Show Gist options
  • Save zyjibmcn/449626dbfdd6b3abf30d886421fb66b1 to your computer and use it in GitHub Desktop.
Save zyjibmcn/449626dbfdd6b3abf30d886421fb66b1 to your computer and use it in GitHub Desktop.
REST API设计原则及最佳实践
1. API为什么这么火?
个人觉得API经济这么火,主要有两方面的原因:
一是越来越多的公司更加注重Ecosystem(生态系统)建设,将自己的服务和数据通过一定的方式共享出去,让开发者和第三方开发相应的应用,
既能扩大自身的资源利用率又能获取更多用户的认可,是一个多赢的局面;
二是移动互联网时代的到来,用户接入的多样化,任何系统都需要面对多终端的情况,造成一个后台,多套前端。需要进行前后端分离。
后端以API的方式提供是一个很好的方式。
2. REST API为什么这么火?
这是由REST 架构风格的好处决定的。虽然不是标准,但被广泛采用,胜似标准。因为不是标准,所以没有实现上的强制要求,有的只是指导原则。
下面是对网络上设计原则及最佳实践的整理。
3. REST API的设计原则
面向资源的;
通过HTTP请求来操纵资源 (GET,POST,PUT,PATCH,DELETE);
资源应该是一个nouns(not verbs);
数据模型和资源之间可以不是一一对应的,要考虑到不要暴露不必要的细节;
Endpoint名称应该总是复数形式(为了是API的URL更加一致);
References:
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
https://github.com/18f/api-standards
http://www.heavybit.com/library/video/2014-09-30-amber-feng
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment