文章目录
开源项目的地址
https://github.com/gothinkster/realworld
1. RESTful接口设计规范
1.1 协议
API与用户的通信协议,尽量使用HTTPs协议
1.2 域名
应该尽量将APP部署在专用域名之下
https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/
1.3 版本
应该将API的版本号放入URL
https://api.example.com/v1/
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github 采用这种做法。
1.4 路径
路径又称"终点"(endpoint) ,表示API的具体网址。
在RESTful架构中,每个网址代表一种资源( resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合” (collection),所以API中的名词也应该使用复数。
举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。