位置: 编程技术 - 正文

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跳转微信支付)

  • m级纳税人如何变成b级
  • 开发票需要填银行吗
  • 个人接私活需要缴税吗
  • 银行回单电子退库是什么意思
  • 哪些费用类专票可以抵扣
  • 税控服务费属于什么费用
  • 资产减值损失属于什么科目借方增加还是减少
  • 房产预收款怎么记帐?
  • 融资性售后回租承租方出售资产为什么不缴纳增值税
  • 结转以前的其他业务成本如何做会计分录呢?
  • 库存方面的会计是做什么的
  • 公司库存现金如何存回银行
  • 房地产企业用电计入什么科目
  • 一般纳税人在国家电子税务局里面如何添加银行账户
  • 增值税普通发票对方作废了怎么办?
  • 一般纳税人苗木发票可以抵扣吗
  • 租金小规模开票税率
  • 广告公司认定一般多少钱
  • 收到汽车保险赔款怎么做账
  • 自然人收税管理
  • 费用转入本年利润
  • 个税经营所得申报怎么更正
  • 主营业务收入平均增长率计算例题
  • 食堂充值管理制度
  • 电脑qq音乐设置在哪里
  • 土地增值税怎么计算举例说明
  • 免税收入与不征税收入的区别
  • 农民专业合作社税收优惠政策
  • element-plus vue
  • 视同销售的八种情况下会计分录怎么做?
  • php function
  • 鱼香肉丝的做法的教程
  • laravel基础
  • PHP:imagecopymerge()的用法_GD库图像处理函数
  • 提取现金 备发工资
  • 总公司签合同后将工程给分公司可以吗
  • defaultpool
  • 睿智目标检测yolov8
  • 基于VGGNet乳腺超声图像数据集分析
  • 关于眼中的世界的作文
  • 消费积分如何做账
  • python3.9怎么清屏
  • 公司银行开户的费用怎么做账
  • 未使用的固定资产计提折旧应当计入
  • 预存5000送2000什么套路
  • 织梦添加文章如何修改高级参数
  • 高效刷题app
  • 基建期业务招待会议记录
  • 企业发行债券的交易费用计入
  • 企业注销了,存钱怎么办
  • 借调是原单位发工资吗
  • 出票后定期付款的汇票,其提示付款的期限为
  • 利息为什么存在
  • 材料已入库后收回怎么办
  • 预提费用多提了怎么办
  • 中小企业收款
  • 销售返利的账务处理案例
  • 机场员工家属机票
  • 我国居民企业判断标准
  • 成品油经销企业资质
  • 待处理财产损益会计分录
  • 连续三个月发烧怎么回事
  • 软件开发的知识产权有哪些
  • 从银行取现金是什么凭证
  • 房地产开发企业资质管理规定
  • 阿里云ecs centos sysctl
  • solaris重启服务器命令
  • mac系统不能用
  • 怎么删除win系统
  • win10系统无法打开这个应用
  • win32api.exe - win32api是什么进程
  • XP IIS5.1 + PHP 5.2.1 + MySQL 5.0.37 + Zend 3.2.6 + phpMyAdmin-2.10.0.2环境配置
  • win8.1无线
  • 用python编写登录程序
  • unity精灵编辑器
  • jquery选择器的使用
  • jquery选择器包含哪几大类
  • unity-x
  • 海南税务局增值税按次缴纳
  • 一般纳税人业务招待费可以抵扣吗
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设