GitHub 的 Restful HTTP API 设计分解
1 / 1 / 创建于 6年前 /
剑尘 的个人博客
什么事RESTful
为什么选择RESTful
RESTful 设计原则
- HTTPS
HTTPS 为接口的安全提供了保障，可以有效防止通信被窃听和篡改。 - 域名
应当尽可能的将 API 与其主域名区分开，可以使用专用的域名，访问我们的 API，例如：
https://api.larabbs.com
或者可以放在主域名下，例如：
https://www.larabbs.com/api - 版本控制
通常情况下，有两种做法：- 将版本号放入URL中
https://api.larabbs.com/v1
https://api.larabbs.com/v2 - 使用HTTP 请求头的Accept字段进行区分
https://api.larabbs.com/
Accept: application/prs.larabbs.v1+json
Accept: application/prs.larabbs.v2+json
- 将版本号放入URL中
- URL统一定位资源
- 用HTTP动词描述动作
- 资源过滤
- 正确使用状态码
- 数据响应格式
- 调用频率限制
- 编写文档
本作品采用《CC 协议》，转载必须注明作者和本文链接
关于 LearnKu
粤公网安备 44030502004330号
推荐文章：