TP5商城开发-REST与RESTful API

岳曦
2023-12-01

REST(基本的思想和理论)

在REST之前的重要协议:SOAP
以前JavaScript是无法直接访问服务器接口的,先访问网站后台,,由网站后台代码通过公共服务提供的WSDL代理类来访问

  • XML格式返回数据(与JSON通用)

REST提供了 更加轻量化的思维方式

RESTful API(是REST在外部接口中的一种应用和延伸)

  • JSON方式返回数据
  • 无状态
  • 基于资源,增删改查都只是对于资源状态的改变
  • 使用HTTP动词来操作资源

选择get或post的依据:
在传统web开发里面,不管是增删改都可用get,若是提交表单就用post;对于REST服务来说,取决于你的操作到底是新增还是查询。

URL资源路径

  • 通过HTTP动词请求去实现
  • 不要在URL中使用动词,要用名词,例:getname不应有get,直接用name即可。

HTTP动词(幂等性、资源安全性)

  • POST:创建
  • PUT:更新
  • GET:查询
  • DELETE:删除

状态码:
404(页面没找到,RESTfUL API:资源没找到)、400(参数错误)、200(查询get请求成功)、201(post创建资源成功)、202(put更新成功)、401(未授权)、403(当前访问被禁止)、500(未知错误或是服务器错误)
错误码:
自定义的错误ID号
统一描述错误:
错误码、错误信息、当前产生错误的url

使用Token令牌来授权和验证身份
API要有版本号
测试环境与生产环境要分开 要用不同的请求地址

URL规范问题

  • 语意要明确 “望文知意“
  • 生成API文档,要有自己的见解

学习RESTful API方式
“模仿”(豆瓣开放API、GitHub开发者API)
但不能盲目照搬标准REST,要针对自己的项目视情况而定。

 类似资料: