电脑桌面
添加蜗牛文库到电脑桌面
安装后可以在桌面快捷访问

微服务 Restful API 的设计规范.docxVIP免费

微服务 Restful API 的设计规范.docx_第1页
微服务 Restful API 的设计规范.docx_第2页
微服务 Restful API 的设计规范.docx_第3页
微服务RestfulAPI的设计规范1.URIURI表示资源,资源一般对应服务器端领域模型中的实体类。URI规范1.不用大写;2.用中杠-不用下杠_;3.参数列表要encode;4.URI中的名词表示资源集合,使用复数形式。资源集合vs单个资源URI表示资源的两种方式:资源集合、单个资源。资源集合:/zoos//所有动物园/zoos/1/animals//id为1的动物园中的所有动物单个资源:/zoos/1//id为1的动物园/zoos/1;2;3//id为1,2,3的动物园避免层级过深的URI/在url中表达层级,用于按实体关联关系进行对象导航,一般根据id导航。过深的导航容易导致url膨胀,不易维护,如GET/zoos/1/areas/3/animals/4,尽量使用查询参数代替路径中的实体导航,如GET/animals?zoo=1&area=3;对Composite资源的访问服务器端的组合实体必须在uri中通过父实体的id导航访问。组合实体不是first-class的实体,它的生命周期完全依赖父实体,无法独立存在,在实现上通常是对数据库表中某些列的抽象,不直接对应表,也无id。一个常见的例子是User—Address,Address是对User表中zipCode/country/city三个字段的简单抽象,无法独立于User存在。必须通过User索引到Address:GET/user/1/addresses2.RequestHTTP方法通过标准HTTP方法对资源CRUD:GET:查询GET/zoosGET/zoos/1GET/zoos/1/employeesPOST:创建单个资源。POST一般向“资源集合”型uri发起POST/animals//新增动物POST/zoos/1/employees//为id为1的动物园雇佣员工PUT:更新单个资源(全量),客户端提供完整的更新后的资源。与之对应的是PATCH,PATCH负责部分更新,客户端提供要更新的那些字段。PUT/PATCH一般向“单个资源”型uri发起PUT/animals/1PUT/zoos/1DELETE:删除DELETE/zoos/1/employees/2DELETE/zoos/1/employees/2;4;5DELETE/zoos/1/animals//删除id为1的动物园内的所有动物HEAD/OPTION用的不多,就不多解释了。安全性和幂等性1.安全性:不会改变资源状态,可以理解为只读的;2.幂等性:执行1次和执行N次,对资源状态改变的效果是等价的。.安全性幂等性GET√√POST××PUT×√DELETE×√安全性和幂等性均不保证反复请求能拿到相同的response。以DELETE为例,第一次DELETE返回200表示删除成功,第二次返回404提示资源不存在,这是允许的。复杂查询查询可以捎带以下参数:.示例备注过滤条件?type=1&age=16允许一定的uri冗余,如/zoos/1与/zoos?id=1排序?sort=age,desc投影?whitelist=id,name,email分页?limit=10&offset=3Bookmarker经常使...

1、当您付费下载文档后,您只拥有了使用权限,并不意味着购买了版权,文档只能用于自身使用,不得用于其他商业用途(如 [转卖]进行直接盈利或[编辑后售卖]进行间接盈利)。
2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。
3、如文档内容存在违规,或者侵犯商业秘密、侵犯著作权等,请点击“违规举报”。

碎片内容

蜗牛文库的最新文档

二年级数学下册其中检测卷二年级数学下册其中检测卷附答案#期中测试卷.pdf
10.00金币
0下载
二年级数学下册期末质检卷(苏教版)二年级数学下册期末质检卷(苏教版)#期末复习 #期末测试卷 #二年级数学 #二年级数学下册#关注我持续更新小学知识.pdf
10.00金币
0下载
二年级数学下册期末混合运算专项练习二年级数学下册期末混合运算专项练习#二年级#二年级数学下册#关注我持续更新小学知识 #知识分享 #家长收藏孩子受益.pdf
10.00金币
1下载
二年级数学下册年月日三类周期问题解题方法二年级数学下册年月日三类周期问题解题方法#二年级#二年级数学下册#知识分享 #关注我持续更新小学知识 #家长收藏孩子受益.pdf
10.00金币
0下载
二年级数学下册解决问题专项训练二年级数学下册解决问题专项训练#专项训练#解决问题#二年级#二年级数学下册#知识分享.pdf
10.00金币
1下载
二年级数学下册还原问题二年级数学下册还原问题#二年级#二年级数学#关注我持续更新小学知识 #知识分享 #家长收藏孩子受益.pdf
10.00金币
1下载
二年级数学下册第六单元考试卷家长打印出来给孩子测试测试争取拿到高分!#小学二年级试卷分享 #二年级第六单考试数学 #第六单考试#二年级数学下册.pdf
10.00金币
0下载
二年级数学下册必背顺口溜口诀汇总二年级数学下册必背顺口溜口诀汇总#二年级#二年级数学下册 #知识分享 #家长收藏孩子受益 #关注我持续更新小学知识.pdf
10.00金币
0下载
二年级数学下册《重点难点思维题》两大问题解决技巧和方法巧算星期几解决周期问题还原问题强化思维训练老师精心整理家长可以打印出来给孩子练习#家长收藏孩子受益 #学霸秘籍 #思维训练 #二年级 #知识点总结.pdf
10.00金币
0下载
二年级数学下册 必背公式大全寒假提前背一背开学更轻松#二年级 #二年级数学 #二年级数学下册 #寒假充电计划 #公式.pdf
10.00金币
0下载
蜗牛文库+ 关注
实名认证
内容提供者

提供各种专业文档内容

确认删除?
QQ
  • QQ点击这里给我发消息
微信客服
  • 微信客服
回到顶部