RestFul接口设计
2019-07-23 08:42:40来源:博客园 阅读 ()
1.接口编程
1.1背景
随着互联网的发展, 尤其是移动互联为代表的Web3.0时代. 客户端层出不穷, 以APP、微信、PC浏览器为代表, 服务端业务逻辑是基本一致的。那么有没有一种方式可以做到”服务端一次编写, 客户端随时接入”呢?
1.2接口编程
API(Application Programming Interface,应用程序编程接口),程序之间交互数据的一种方式。
请求方式:get方式 post方式
请求协议:http协议 https协议
GET: 从服务器获取资源(一项或多项)
POST: 在服务器新建一个资源
PUT: 在服务器更新资源, 服务器返回完整的属性
DELETE: 从服务器删除资源
如果状态码是4xx或者5xx, 需要告诉客户端对应的错误信息. 通常以Json格式返回:
{
“error”: “错误信息”,
}
2.2.6
针对不同的操作, 服务需要返回的结果应该符合这样的规范
GET /collections -- 返回资源列表(数组)
GET /collections/:id -- 返回单个资源 eg. /collections/1
POST /collections -- 返回新生成的资源
PUT /collections/:id -- 返回资源的完整属性
DELETE /collections/:id -- 返回204状态码+空文档
实际开发中,通常会将 状态码、错误信息、返回数据,都放到返回结果中。
RESTFul 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。
4.接口文档
4.1接口内容
4.2请求参数内容
4.3响应参数内容
4.4错误码内容
原文链接:https://www.cnblogs.com/shineguang/p/11173477.html
如有疑问请与原作者联系
标签:
版权申明:本站文章部分自网络,如有侵权,请联系:west999com@outlook.com
特别注意:本站所有转载文章言论不代表本站观点,本站所提供的摄影照片,插画,设计作品,如需使用,请与原作者联系,版权归原作者所有
上一篇:【多进程】php多进程编程
下一篇:PHP代码篇(三)--常用方法
- PHP设计模式之工厂模式详解 2020-02-19
- PHP网页安全认证的实例详解 2020-01-16
- php调用云片网接口发送短信的实现方法 2019-12-14
- 详解PHP接口继承及接口多继承原理与实现方法 2019-12-13
- 分享PHP+MySQL投票系统的设计和实现 2019-11-21
IDC资讯: 主机资讯 注册资讯 托管资讯 vps资讯 网站建设
网站运营: 建站经验 策划盈利 搜索优化 网站推广 免费资源
网络编程: Asp.Net编程 Asp编程 Php编程 Xml编程 Access Mssql Mysql 其它
服务器技术: Web服务器 Ftp服务器 Mail服务器 Dns服务器 安全防护
软件技巧: 其它软件 Word Excel Powerpoint Ghost Vista QQ空间 QQ FlashGet 迅雷
网页制作: FrontPages Dreamweaver Javascript css photoshop fireworks Flash