Restful理解
API(Application Programming Interface),顾名思义:是一组编程接口规范,客户端与服务端通过请求响应进行数据通信。REST(Representational State Transfer)决定了接口的形式与规则。
RESTful是基于http方法的API设计风格,而不是一种新的技术.
- 看
Url
就知道要什么资源 - 看
http Method
就知道对资源干什么 - 看
http status code
就知道结果如何
它规范了程序员的代码开发,前后端分离模式中非常实用,'约定大于配置'。
RESTFUL API的设计风格
REST是面向资源的(名词)
REST 通过 URI 暴露资源时,会强调不要在 URI 中出现动词。比如:
GET /api/getDogs | GET /api/dogs/{id} | 获取一个小狗狗 |
GET /api/getDogs | GET /api/dogs | 获取所有小狗狗 |
GET /api/addDogs | POST /api/dogs | 添加一个小狗狗 |
GET /api/editDogs/{id} | PUT /api/dogs/{id} | 修改一个小狗狗 |
GET /api/deleteDogs/{id} | DELETE /api/dogs/{id} | 删除一个小狗狗 |
用HTTP方法体现对资源的操作(动词)
- GET:获取、读取
- POST:添加
- PUT:修改、更新
- DELETE:删除
HTTP状态码
通过HTTP状态码体现动作的结果,不要自定义
200 OK
400 Bad Request
500 Internal Server Error
通过状态码的含义很清楚的就知道响应的结果,发生了什么
版本化API
强制性增加API版本声明,不要发布无版本的API。正确的如:/api/v1/blog
面向扩展开放,面向修改关闭:也就是说一个版本的接口开发完成测试上线之后,我们一般不会对接口进行修改,如果有新的需求就开发新的接口进行功能扩展。这样做的目的是:当你的新接口上线后,不会影响使用老接口的用户。如果新接口目的是替换老接口,也不要在v1版本原接口上修改,而是开发v2版本接口,并声明v1接口废弃!