博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
yii2 RESTful api的详细使用
阅读量:6213 次
发布时间:2019-06-21

本文共 3023 字,大约阅读时间需要 10 分钟。

  hot3.png

作者:白狼 出处: 本文版权归作者,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。

什么是RESTful风格的API

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

Yii2如何实现RESTful风格的API

1、建立单独的应用程序

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

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

├─assets│      AppAsset.php├─config│      bootstrap.php│      main-local.php│      main.php│      params-local.php│      params.php├─runtime└─web    │ index.php    ├─assets    └─css

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

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

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

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

'components' => [    // other config    'urlManager' => [        'enablePrettyUrl' => true,        'showScriptName' => false,        'enableStrictParsing' =>true,        'rules' => [],    ]],

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

Options +FollowSymLinksIndexIgnore */*RewriteEngine on# if a directory or a file exists, use it directlyRewriteCond %{REQUEST_FILENAME} !-fRewriteCond %{REQUEST_FILENAME} !-d# otherwise forward it to index.phpRewriteRule . index.phpRewriteRule \.svn\/  /404.htmlRewriteRule \.git\/  /404.html

3、利用gii生成测试modules

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

CREATE TABLE `goods` (  `id` int(11) NOT NULL AUTO_INCREMENT,  `name` varchar(100) NOT NULL DEFAULT '',  PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8;INSERT INTO `goods` VALUES ('1', '11111');INSERT INTO `goods` VALUES ('2', '22222');INSERT INTO `goods` VALUES ('3', '333');INSERT INTO `goods` VALUES ('4', '444');INSERT INTO `goods` VALUES ('5', '555');

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

(图片参考原文)

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

│├─models│      Goods.php│├─modules│  └─v1│      │  Module.php│      ││      ├─controllers│      │      DefaultController.php│      │      GoodsController.php│      ││      └─views│          └─default│                  index.php

4、重新配置控制器

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

5、为Goods配置Url规则

'rules' => [    [        'class' => 'yii\rest\UrlRule',        'controller' => ['v1/goods']    ],]

6、模拟请求操作

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

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

(postman截图见原文)

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

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

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

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

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

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

7、关于授权认证

[考虑目前国内网站大部分采集文章十分频繁,更有甚者不注明原文出处,原作者更希望看客们查看原文,以防有任何问题不能更新所有文章,避免误导!]

转载于:https://my.oschina.net/manks/blog/709238

你可能感兴趣的文章
DBCC--CHECKDB--结果收集
查看>>
Java中的锁概念
查看>>
iPhone开发 调用摄像头进行拍照等操作
查看>>
Javascript 坦克游戏源码分享
查看>>
CMMI 是什么东西?
查看>>
android 自定义动画按钮
查看>>
谷歌浏览器双击关闭标签页的扩展插件Pig Toolbox
查看>>
类名.class和getClass()区别
查看>>
TestNG+ReportNG+Maven优化测试报告
查看>>
2017年这个市场价值5000亿 京东豪取六成以上份额
查看>>
苏宁董事长张近东儿子张康阳成国际米兰俱乐部主席
查看>>
浙江义乌外商当志愿者助力春运 一口流利汉语获赞
查看>>
日媒:日本太地町渔协计划7月重启商业捕鲸
查看>>
人社部:加强人才队伍建设 深化事业单位人事制度改革
查看>>
上海豫园新春民俗艺术灯会亮灯 “财神猪”受热捧
查看>>
上海率先成立政府主导的“筛查诊治中心”
查看>>
EOS单日暴涨41%,市值超过莱特币,位居虚拟货币第5
查看>>
中国大型舞剧《大梦敦煌》惊艳狮城
查看>>
B站弹幕机,看看月薪20K程序员怎么在10分钟用原生javascript写出来!
查看>>
聊聊微软刚发布的区块链去中心化身份识别系统DID
查看>>