微服务框架相关技术整理 (11)

URL结尾不应该包含斜杠 "http://www.likecs.com/": URI中的每个字符都会计入资源的唯一身份的识别中,这是作为URL路径中处理中最重要的规则之一,正斜杠"http://www.likecs.com/"不会增加语义值,且可能导致混淆.RESTful API不允许一个尾部的斜杠,不应该将它们包含在提供给客户端的链接的结尾处.两个不同的URI映射到两个不同的资源.如果URI不同,那么资源也是如此,反之亦然.因此,RESTful API必须生成和传递精确的URI,不能容忍任何的客户端尝试不精确的资源定位.

正斜杠分隔符 "http://www.likecs.com/" 必须用来指示层级关系: URI的路径中的正斜杠 "http://www.likecs.com/" 字符用于指示资源之间的层次关系

应该使用连字符 "-" 来提高URL的可读性,而不是使用下划线 "_": 为了使URL容易让人们理解,要使用连字符 "-" 字符来提高长路径中名称的可读性

URL路径中首选小写字母: RFC 3986将URI定义为区分大小写,但scheme 和 host components 除外

URL路径名词均为复数: 为了保证url格式的一致性,建议使用复数形式

RESTful API对资源的操作

对于RESTful API资源的操作,由HTTP动词表示:

get: 获取资源

post: 新建资源

put: 在服务器更新资源(向客户端提供改变后的所有资源)

delete: 删除资源
patch:在服务器更新资源(向客户端提供改变的属性),一般不用,用put

资源过滤: 在获取资源的时候,有可能需要获取某些“过滤”后的资源

例如指定前10行数据: ?page=1&page-size=10

返回状态码,推荐标准HTTP状态码: 有很多服务器将返回状态码一直设为200,然后在返回body里面自定义一些状态码来表示服务器返回结果的状态码.由于RESTful API是直接使用的HTTP协议,所以它的状态码也要尽量使用HTTP协议的状态码

200 OK 服务器返回用户请求的数据,该操作是幂等的 201 CREATED 新建或者修改数据成功 204 NOT CONTENT 删除数据成功 400 BAD REQUEST 用户发出的请求有问题,该操作是幂等的 401 Unauthoried 表示用户没有认证,无法进行操作 403 Forbidden 用户访问是被禁止的 422 Unprocesable Entity 当创建一个对象时,发生一个验证错误 500 INTERNAL SERVER ERROR 服务器内部错误,用户将无法判断发出的请求是否成功 503 Service Unavailable 服务不可用状态,多半是因为服务器问题,例如CPU占用率大,等等

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wsfpxd.html