REST

千帆开发孙兵

什么是REST

资源

数据集合

资源方法

HTTP/1.1协议中共定义了八种方法来以不同方式操作指定的资源：

• GET 向指定的资源发出“显示”请求。使用GET方法应该只用在读取数据，而不应当被用于产生“副作用”的操作中
• POST 向指定资源提交数据，请求服务器进行处理（例如提交表单或者上传文件）。数据被包含在请求本文中。这个请求可能会创建新的资源或修改现有资源，或二者皆有。
• PUT 向指定资源位置上传其最新内容。
• DELETE 请求服务器删除Request-URI所标识的资源。
  
  

如何设计一个RESTful api

url设计

RESTful api

• GET         /orders             订单集合查询
• GET         /orders/123      订单号为123的订单查询
• POST      /orders              创建一个订单
• PUT        /order/123         更新订单号为123的订单的相关信息
• DELETE  /orders/123       删除订单号为123的订单
  
  

优缺点

• 优点：自描述，规范统一，应用广，适合粒度小的业务
• 缺点：不够灵活，复杂的业务逻辑不适用
  
  

千帆开放接口的REST应用

yii-rest

RESTful 的 API 都是关于访问和操作 资源，可将资源看成 MVC 模式中的模型

https://www.yiiframework.com/doc/guide/2.0/zh-cn/rest-quick-start

自定义

• 重写路由
• 对查询方法进行扩展     IndexAction.php/ViewAction.php
• 支持非REST方式
  
  

Reference

• https://restfulapi.net/
• http://www.ruanyifeng.com/blog/2014/05/restful_api.html
• https://www.yiiframework.com/doc/guide/2.0/zh-cn/rest-quick-start
• https://codeplanet.io/principles-good-restful-api-design/