RESTful API接口设计规范.pdfVIP

  1. 1、本文档共5页,可阅读全部内容。
  2. 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
  3. 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载
  4. 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
  5. 5、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
  6. 6、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们
  7. 7、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
  8. 8、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多

RESTfulAPI接口设计规范--第1页

RESTfulAPI接口设计规范

随着互联网的普及,Web技术的快速发展,越来越多的应用程

序开始前后端分离,前端通过RESTfulAPI接口与后端进行交互。

为了保证RESTfulAPI接口的良好使用体验和开发效率,设计

RESTfulAPI接口需要遵守一定的规范。

一、RESTfulAPI接口设计原则

1.资源定位

RESTfulAPI接口应该通过URL来标识资源的位置,URL中使

用标准的HTTP方法(GET、POST、PUT、DELETE)和标准的

HTTP状态码(200OK、201Created、204NoContent、400Bad

Request、401Unauthorized、403Forbidden、404NotFound等)。

例如:GET/articles/1表示获取ID为1的文章信息,PUT

/articles/1表示更新ID为1的文章信息,DELETE/articles/1表示

删除ID为1的文章信息,POST/articles表示创建一篇新的文章。

2.统一接口

RESTfulAPI接口设计规范--第1页

RESTfulAPI接口设计规范--第2页

RESTfulAPI接口应该具有统一的接口,首先需要确定资源的

URL和资源的请求方式,其次需要确定请求的参数和返回的格式。

例如:GET/articles?category=1status=1表示获取分类为1,

状态为1的文章列表,返回JSON格式的数据。

3.无状态通信

RESTfulAPI接口应该保持无状态通信,即每次请求都包含所

有必要的信息,应用程序无需维护用户状态。

例如:用户每次请求API之前,需要通过OAuth认证或者

Token认证获得访问权限,每次请求都需要添加Token等认证信息,

避免请求与服务器之间的状态不同步。

二、RESTfulAPI接口设计规范

1.资源命名

RESTfulAPI接口设计规范--第2页

RESTfulAPI接口设计规范--第3页

RESTfulAPI接口中的资源应该使用名词作为资源名称,使用

复数形式表示一组资源,使用短横线(-)作为单词之间的连接符。

例如:GET/articles表示获取文章列表,GET/articles/1表示获

取ID为1的文章信息,POST/articles表示创建新的文章,PUT

/articles/1表示更新ID为1的文章信息,DELETE/articles/1表示

删除ID为1的文章信息。

2.响应格式

RESTfulAPI接口应该使用JSON格式作为响应的数据格式,

因为JSON格式比XML格式更节省带宽,解析速度更快,易于读

写和理解。

例如:GET/articles返回JSON格式的文章列表数据,GET

/articles/1返回JSON格式的ID为1的文章信息,POST/articles返

回JSON格式的新文章信息。

3.请求参数

RESTfulAPI接口设计规范--第3页

RESTfulAPI接口设计规范--第4页

RESTfulAPI接口中的请求参数应该使用短横线(-)作为连接符,

不使用下划线(_)或者驼峰式命名。

例如:GET/articles?category-id=1status-code=1表示获取分类

文档评论(0)

176****0230 + 关注
实名认证
文档贡献者

该用户很懒,什么也没介绍

1亿VIP精品文档

相关文档