RESTful架构和RESTful API设计总结
开发者全社区
共 2954字，需浏览 6分钟
·
2022-04-18 15:25
上一篇：支付宝系统架构（内部架构图）
作者：智明书
链接：https://www.jianshu.com/p/955eb2faa354
Resource 资源
.html后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。xml格式，html格式，json格式，甚至是二进制格式，图片可以有PNG格式，JPEG格式等。资源的一个具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。State Transfer 状态转移
通过http动词来实现资源的状态转移，用GET来请求资源，用POST来新建资源，用PUT来更新资源，用DELETE来删除资源。
简明扼要的总结REST：
RESTful API设计总结
随着近年来移动互联网的发展，各种客户端出不穷：Web，IOS，Android。因此需要一种机制使得各种客户端能够和服务端进行通讯，这就使得RESTful API的架构流行起来。另外，搜索公众号互联网架构师后台回复“面试”，获取一份惊喜礼包。RESTful是REST(表现层状态转化)的形容词形式，因此RESTful API就可以理解成“符合REST风格的API”。
格式规范
- 来隔断单词，而不是使用 _。这主要是因为，浏览器中超链接显示的默认效果是文字并附带下划线，如果API以_隔断单词，二者会重叠，影响可读性。/api/featured-post/ # GOOD
/api/featured_post/ # WRONG
协议
域名
https://api.example.com/v1。也可以简单地把版本放在URL中，比如https://www.example.com/api/v1版本
API的版本号应该放在URL中：
https://api.example.com/v1/
名词应该使用复数
https://api.example.com/v1/students
https://api.example.com/v1/schools
https://api.example.com/v1/employees
URL中不能使用动词
不符合CRUD的情况
http://api.xxx.com/apiv3/search?timestamp=123213218&user_id=4192121&keyword=2134789。再例如创建了博客网站，如果想要发布一个博客，可以使用POST /articles/{:id}/publish用HTTP动词表示对资源的操作
GET https://api.example.com/v1/schools # 列出所有学校
POST https://api.example.com/v1/schools # 新建一个学校
GET https://api.example.com/v1/schools/ID # 列出指定学校的信息
DELETE https://api.example.com/v1/schools/ID # 删除指定学校
GET https://api.example.com/v1/schools/ID/students # 列出指定学校的所有学生
DELETE https://api.example.com/v1/schools/ID/students/ID # 删除指定学校的指定学生
HTTP状态码
200 OK - [GET]：服务器成功返回用户请求的数据 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功 204 NO CONTENT - [DELETE]：用户删除数据成功 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作 另外，搜索公众号互联网架构师后台回复“面试”，获取一份惊喜礼包。 401 UNAUTHORIZED：表示用户没有权限（令牌、用户名、密码错误） 404 NOT FOUND：用户发出的请求针对的是不存在的记录，服务器没有进行操作 500 INTERNAL SERVER ERROR：服务器发生错误，用户将无法判断发出的请求是否成功
其它
服务器返回的数据格式，应该尽量使用JSON，避免使用XML。JSON有可读性强，结构紧凑，支持的语言种类多的特点，因此JSON是RESTful API最常用的返回格式。
PS：如果觉得我的分享不错，欢迎大家随手点赞、转发、在看。
评论