位置: 编程技术 - 正文

Yii2 RESTful中api的使用及开发实例详解(rest for api)

编辑:rootadmin

推荐整理分享Yii2 RESTful中api的使用及开发实例详解(rest for api),希望有所帮助,仅作参考,欢迎阅读内容。

文章相关热门搜索词:restful api教程,restful接口规范 入参,es restful api文档,restful api json,restful api json,restful接口规范 入参,rest.api,restful api json,内容如对您有帮助,希望把文章链接给更多的朋友!

什么是RESTful风格的API

对于各种客户端设备与服务端的通信,我们往往都通过API为客户端提供数据,提供某种资源。关于RESTful的概念,一查一大推,一两句也解释不清,姑且先按照我们通俗的理解:在众多风格、众多原则的API中,RESTful就是一套比较优秀的接口调用方式。

Yii2如何实现RESTful风格的API

1、建立单独的应用程序

为了增加程序的可维护性,易操作性,我们选择新建一套应用程序,这也是为了和前台应用、后台应用区分开操作。有些人要嚷嚷了,为啥非得单独搞一套呢?如果你就单纯的提供个别的几个h5页面的话,那就没有必要了,但事实往往是客户端要升级啊,要增加不同的版本啊,这就需要我们不但要后端不仅要增加一套单独的应用程序,我们还要增加各种版本去控制。

在WEB前端(frontend)和后端(backend)的同级目录,新建一个文件夹,命名api,其目录结构如下所示:

可以看出其目录结构基本上同backend没有其他差异,因为我们就是拷贝backend项目,只是做了部分优化。

2、为新建的api应用程序美化路由

首先保证你的web服务器开启rewrite规则,细节我们就不说了,不过这是前提。

接着配置api/config/main.php文件

最后只需要在应用入口同级增加.htaccess文件就好,我们以apache为例

3、利用gii生成测试modules

用了便于演示说明,我们新建一张数据表goods表,并向其中插入几条数据。

接着我们先利用gii生成modules后,再利用gii模块,按照下图中生成goods信息

现在,我们的api目录结构应该多个下面这几个目录

4、重新配置控制器

为了实现restful风格的api,在yii2中,我们需要对控制器进行一下改写

5、为Goods配置Url规则

6、模拟请求操作

经过上面几个步骤,到此我们已经为goods成功创建了满足restful风格的api了。为了更好更方便的演示,我们借助工具postman进行模拟请求。

为了见证一下我们的操作,我们用postman请求一下GET /v1/goods看看结果如何:

从上面截图中可以清楚的看到,GET /v1/goods 已经能够很方便的获取我们表中的数据了。

当然,yii2还对该api封装了如下操作:

Yii2 RESTful中api的使用及开发实例详解(rest for api)

GET /users: 逐页列出所有用户HEAD /users: 显示用户列表的概要信息POST /users: 创建一个新用户GET /users/: 返回用户 的详细信息HEAD /users/: 显示用户 的概述信息PATCH /users/ and PUT /users/: 更新用户DELETE /users/: 删除用户OPTIONS /users: 显示关于末端 /users 支持的动词OPTIONS /users/: 显示有关末端 /users/ 支持的动词

不信的话我们可以利用postman发送一个post请求到/v1/goods,我们会发现成功创建了一个新的商品。

需要提醒的是,操作中还请细心且注意:

如果你的控制器末端不是复数(比如是blog非blogs)请保证请求的时候是复数!这是因为在RESTful架构中,网址中只能有名词而不能包含动词,名词又往往与数据表相对应,数据表呢又是一个“集合”,因此该名词往往是复数的形式。

7、关于授权认证

为什么需要授权认证?这在一般的操作中是需要的。比如说用户要设置自己的信息。

为了对yii2 restful授权认证说的更清楚,我们将会以两个两种不同的方法进行说明。

首先需要开启认证:

假设我们已经按照第3步创建了包含字段access-token的数据表user,而且利用gii上生成了相应的model和controller

配置main.php文件

为控制器配置authenticator行为指定认证方式

最后我们还需要在identityClass中实现findIdentityByAccessToken方法

如此一来,我们先通过postman模拟不带access-token请求看结果

提示 我们没有权限访问!

我们在请求的链接上携带正确的access-token,认证通过后,控制器会再继续执行其他检查(频率限制、操作权限等),才可以返回正确的用户信息。

需要提醒的是:通过url的形式对access-token传递存在一定的风险,有可能会造成数据的泄漏!一般而言,access-token需要放到HTTP头中进行传递!除非客户端的请求是jsonp格式的!

8、速率限制

速率限制,该操作完全也是出于安全考虑,我们需要限制同一接口某时间段过多的请求。

速率限制默认不启用,用启用速率限制,yiiwebUser::identityClass 应该实现yiifiltersRateLimitInterface,也就是说我们的commonmodelsUser.php需要实现yiifiltersRateLimitInterface接口的三个方法,具体代码可参考:

需要注意的是,你仍然需要在数据表User中新增加两个字段

allowance:剩余的允许的请求数量

allowance_updated_at:相应的UNIX时间戳数

在我们启用了速率限制后,Yii 会自动使用 yiifiltersRateLimiter 为 yiirestController 配置一个行为过滤器来执行速率限制检查。

现在我们通过postman请求v1/users再看看结果,会发现在秒内调用超过5次API接口,我们会得到状态为太多请求的异常信息。

9、关于版本

为了兼容历史版本而且考虑向后兼容性,我们在一开始操作的时候就以URL的方式实现了版本话,这里就不再进行阐述了。

、错误处理

Yii的REST框架的HTTP状态代码可参考如下就好,没啥好说的

: OK。一切正常。: 响应 POST 请求时成功创建一个资源。Location header 包含的URL指向新创建的资源。: 该请求被成功处理,响应不包含正文内容 (类似 DELETE 请求)。: 资源没有被修改。可以使用缓存的版本。: 错误的请求。可能通过用户方面的多种原因引起的,例如在请求体内有无效的JSON 数据,无效的操作参数,等等。: 验证失败。: 已经经过身份验证的用户不允许访问指定的 API 末端。: 所请求的资源不存在。: 不被允许的方法。 请检查 Allow header 允许的HTTP方法。: 不支持的媒体类型。 所请求的内容类型或版本号是无效的。: 数据验证失败 (例如,响应一个 POST 请求)。 请检查响应体内详细的错误消息。: 请求过多。 由于限速请求被拒绝。: 内部服务器错误。 这可能是由于内部程序错误引起的。

PHP通过微信跳转的Code参数获取用户的openid(关键代码) 关键代码如下所示://获取微信登录用户信息functiongetOpenID($appid,$appsecret,$code){$url="

PHP判断JSON对象是否存在的方法(推荐) 在实际测试中php读取json数组时使用简单的if或者array_key_exists去判断对象是否存在是会报错的,以下是google搜寻的正确判断方法实际上出现报错只是我对php

thinkPHP+PHPExcel实现读取文件日期的方法(含时分秒) 本文实例讲述了thinkPHP+PHPExcel实现读取文件日期的方法。分享给大家供大家参考,具体如下:我们使用PHPExcel读取excel文件后发现,时间都是类似于这样

标签: rest for api

本文链接地址:https://www.jiuchutong.com/biancheng/297006.html 转载请保留说明!

上一篇:PHP单链表的实现代码(php链表的应用场景)

下一篇:PHP通过微信跳转的Code参数获取用户的openid(关键代码)(php跳转微信支付)

  • 红冲去年暂估的费用怎么做账
  • 装订需要多长时间
  • 全年一次性奖金单独计税怎么算
  • 个税专项附加扣除
  • 刷单成本计入什么费用?
  • 飞机票改签费用怎么算1000块
  • 生产企业出口退税流程
  • 增值税专用发票验票
  • 商业保险和交强险区别
  • 工会经费申报表的应税项应该怎样填写
  • 合伙企业分配比例税法规定
  • 个体户没有对公账户可以转个人账户吗
  • 远期结汇账务处理分录
  • 企业所得税发票虚假成本调减当年的吗
  • 会计帐务处理程序
  • 在windows7的
  • 什么是商务接待与拜访
  • 企业对外股权投资涉及税收
  • 工商年报中生育保险本期实际缴费金额
  • linux命令df -h结果详解
  • 简单了解php编程软件
  • 存货周转率公式怎么算
  • php api
  • 上月抵扣的发票怎么开
  • React常见面试题
  • 企业发放误餐补助需要票据吗
  • 发票刮出来的奖有兑奖时间
  • 实收资本本年利润属于什么科目
  • json解析格式
  • html盒子边框圆角
  • 有哪些天气软件
  • 员工报销医药费的会计分录
  • 给分公司开的发票,总公司付的款可以吗
  • mysql分区语句
  • mysql 临键锁
  • 贷款减值准备怎么进损益类账户
  • 资产的账面价值大于计税基础
  • 企业增值税申报流程
  • 企业向个人借款利息如何缴纳增值税
  • 将织梦dedecms转换到wordpress
  • 织梦产品详情页相关产品推荐调用代码
  • 帝国cms到底好不好
  • python中exec执行如何获取返回值
  • 公司没有车加油费怎么报
  • 电缆租赁发票开具属于什么项目
  • 小型商贸企业
  • 公司可以打款给中间人
  • 进项税大于销项税怎么结转
  • 计提房产税土地使用税
  • 公司没有账套怎么做账
  • 生产企业成本核算案例
  • 预算外的收入
  • 认缴资金可以增加吗
  • 购买材料发生商损怎么算
  • 车辆保险费计入现金流量表哪里
  • 外币财务报表的折算
  • 出口货物开票怎么处理
  • sql自定义变量
  • gridview自定义排序
  • window如何还原系统
  • 系统升级中怎么办
  • 如何设置windows密码
  • 苹果MaC系统查找微信储存文件
  • windows8开发者预览版中文版ISO下载
  • windows7 读不了u盘怎么解决
  • win10预览体验win11
  • python三角形角度
  • jquery日期插件
  • 安卓如何取消长按电源键关机
  • 基于JAVASCRIPT实现的可视化工具是
  • js的判断类型
  • jq 使用
  • javascript常用的数据类型有哪些
  • htmlcssjavascript入门经典pdf
  • android下拉刷新上拉加载
  • 深入理解innodb
  • 重庆市电子税务局官网登录入口注册
  • 河南税务机关
  • 企业房产税公式
  • 深圳海吉星管理处电话
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

    网站地图: 企业信息 工商信息 财税知识 网络常识 编程技术

    友情链接: 武汉网站建设