> PS:免费章节转载注明出处,本篇如果是收费章节禁止转载。违者必究。 作者:[字母哥博客](http://www.zimug.com) 本文出自:[springboot深入浅出系列](http://springboot.zimug.com) ## 一、本文大纲 * RESTful风格API的好处 * RESTful API的设计风格 ## 二、RESTful风格API的好处 API(Application Programming Interface),顾名思义:是一组编程接口规范,客户端与服务端通过请求响应进行数据通信。REST(Representational State Transfer)决定了接口的形式与规则。**RESTful是基于http方法的API设计风格,而不是一种新的技术.** 1. 看Url就知道要什么资源 2. 看http method就知道针对资源干什么 3. 看http status code就知道结果如何 对接口开发提供了一种可以广泛适用的规范,为前端后端交互减少了接口交流的口舌成本,是**约定大于配置**的体现。通过下面的设计,大家来理解一下这三句话。 >当然也不是所有的接口,都能用REST的形式来表述。在实际工作中,灵活运用,我们用RESTful风格的目的是为大家提供统一标准,避免不必要的沟通成本的浪费,形成一种通用的风格。就好比大家都知道:伸出大拇指表示“你很棒“的意思,绝大部分人都明白,因为你了解了这种风格习惯。但是不排除有些地区伸出大拇指表示其他意思,就不适合使用! ## 二、RESTful API的设计风格 ### 2.1、REST 是面向资源的(名词) REST 通过 URI 暴露资源时,会强调不要在 URI 中出现动词。比如: | 不符合REST的接口URI | 符合REST接口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}|删除一个小狗狗| ### 2.2、用HTTP方法体现对资源的操作(动词) * GET : 获取、读取资源 * POST : 添加资源 * PUT : 修改资源 * DELETE : 删除资源 ![](https://img.kancloud.cn/77/8c/778c1a6b6927d9d4d1b0b038fecf0e38_955x422.png) 实际上,这四个动词实际上就对应着增删改查四个操作,这就利用了HTTP动词来表示对资源的操作。 ### 2.3. HTTP状态码 通过HTTP状态码体现动作的结果,不要自定义 ``` 200 OK 400 Bad Request 500 Internal Server Error ``` 在 APP 与 API 的交互当中,其结果逃不出这三种状态: * 所有事情都按预期正确执行完毕 - 成功 * APP 发生了一些错误 – 客户端错误(如:校验用户输入身份证,结果输入的是军官证,就是客户端输入错误) * API 发生了一些错误 – 服务器端错误(各种编码bug或服务内部自己导致的异常) 这三种状态与上面的状态码是一一对应的。如果你觉得这三种状态,分类处理结果太宽泛,http-status code还有很多。建议还是要遵循KISS(Keep It Stupid and Simple)原则,上面的三种状态码完全可以覆盖99%以上的场景。这三个状态码大家都记得住,而且非常常用,多了就不一定了。 ### 2.4. Get方法和查询参数不应该改变数据 改变数据的事交给POST、PUT、DELETE ### 2.5. 使用复数名词 /dogs 而不是 /dog ### 2.6. 复杂资源关系的表达 GET /cars/711/drivers/ 返回 使用过编号711汽车的所有司机 GET /cars/711/drivers/4 返回 使用过编号711汽车的4号司机 ### 2.7. 高级用法:HATEOAS **HATEOAS**:Hypermedia as the Engine of Application State 超媒体作为应用状态的引擎。 RESTful API最好做到HATEOAS,**即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么**。比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档。 ```json {"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }} ``` 上面代码表示,文档中有一个link属性,用户读取这个属性就知道下一步该调用什么API或者可以调用什么API了。 ### 2.8. 资源**过滤、排序、选择和分页**的表述 ![](https://img.kancloud.cn/41/b9/41b90d46f19fe1277a5fc6e2828bbd39_845x190.png) ### 2.9. 版本化你的API 强制性增加API版本声明,不要发布无版本的API。如:/api/v1/blog **面向扩展开放,面向修改关闭**:也就是说一个版本的接口开发完成测试上线之后,我们一般不会对接口进行修改,如果有新的需求就开发新的接口进行功能扩展。这样做的目的是:当你的新接口上线后,不会影响使用老接口的用户。如果新接口目的是替换老接口,也不要在v1版本原接口上修改,而是开发v2版本接口,并声明v1接口废弃!