使用Yii2进行编程：构建RESTful API

最新推荐文章于 2024-04-20 09:56:59 发布
最新推荐文章于 2024-04-20 09:56:59 发布
阅读量586 收藏
点赞数
文章标签： 控制器 java python http web
最终产品图片
您将要创造的

在本 使用Yii2编程系列中 ，我指导读者使用PHP的Yii2框架。 您可能还对我 的Yii Framework简介 感兴趣 ，它 介绍了Yii 的好处，并概述了Yii 2.x的新增功能。

在今天的教程中，我将回顾如何在Yii中构建REST API，以将您的应用程序连接到云，移动应用程序和其他服务。 我将指导您阅读Yii的REST API快速入门指南，并提供上下文和常见请求示例。

Yii REST API入门

实际上，在Yii中构建REST API非常简单。 您可以利用现有的MVC框架，但是您正在创建一个打算供不同类型的服务（而非网站访问者）访问的独特访问点。

Yii REST框架的好处

Yii框架为构建API提供了广泛的支持和详细的文档。 以下是构建API时的一些内置功能：

  • 支持Active Record常用API的快速原型设计。 这使您可以通过API快速轻松地公开数据模型CRUD功能。
  • 响应格式协商（默认情况下支持JSON和XML）。 内置支持以通用输出格式返回数据。
  • 可定制的对象序列化，支持可选的输出字段。 修改返回的数据很容易。
  • 正确格式化收集数据和验证错误。
  • 支持将超媒体作为应用程序状态引擎（HATEOAS）
  • 带有正确的HTTP动词检查的高效路由。
  • 对OPTIONS和HEAD动词的内置支持。
  • 认证和授权。
  • 数据缓存和HTTP缓存。
  • 速率限制。

今天，我将没有机会接触到所有这一切。

我对REST API的兴趣

在本集中，我将构建一个API，以使我们可以从Twitter API教程中处理在Twixxr服务中创建的Item表。 但是我还计划为我们的入门教程系列 会议Meeting Planner构建API。 为该服务构建iOS应用程序将需要安全的API。 该API将启用移动应用程序与云服务之间的通信。

构建REST控制器

使用Yii的REST框架，我们将为我们的API创建一个端点，并为每种类型的资源组织控制器。

资源本质上是我们应用程序的数据模型。 这些扩展了yii \ base \ Model 。

yii \ rest \ UrlRule类提供了将我们的数据模型映射到API CRUD端点的现成路由：

编写Yii2 REST API网址CRUD API端点的文档

创建树以充当API端点

在Yii2 Advanced模板中 ，有一个前端和后端树，并且这是可扩展的。 为了分离出API功能，我们将创建第三棵树以纯粹充当API端点。

Yii开发人员Alex Makarov提供了此有用的指南来创建其他树 ，随后我创建了第三棵树： 

$ cp -R backend api
$ cp -R environments/dev/backend/ environments/dev/api
$ cp -R environments/prod/backend/ environments/prod/api

然后，我使用Atom编辑器进行了全局查找，并在新的api树中将“后端”替换为“ api”。

我将api别名添加到/common/config/bootstrap.php： 

<?php
Yii::setAlias('@common', dirname(__DIR__));
Yii::setAlias('@frontend', dirname(dirname(__DIR__)) . '/frontend');
Yii::setAlias('@backend', dirname(dirname(__DIR__)) . '/backend');
Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');
Yii::setAlias('@console', dirname(dirname(__DIR__)) . '/console');
Yii::setAlias('@twixxr', dirname(dirname(__DIR__)) . '/twixxr');

配置传入请求的URL路由

在/api/config/main.php中，我们需要添加request[]来解析设置JSON解析，并添加UrlRule来关联模型及其端点的方法： 

return [
    'id' => 'app-api',
    'basePath' => dirname(__DIR__),
    'controllerNamespace' => 'api\controllers',
    'bootstrap' => ['log'],
    'modules' => [],
    'components' => [
      'request' => [
        'parsers' => [
          'application/json' => 'yii\web\JsonParser',
        ],
      ],
      'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
          ['class' => 'yii\rest\UrlRule', 'controller' => 'item'],
          ['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
        ],
      ],

基本上就可以为这些模型启用一些丰富的API功能。

cURL的示例

让我们开始提出请求。

要求选项

向我展示可用的API方法： 

curl -i -H "Accept: application/json" 
    -X OPTIONS "http://localhost:8888/api/items"

这是响应（ GET, POST, HEAD, OPTIONS ）： 

HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 20:23:10 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Allow: GET, POST, HEAD, OPTIONS
Content-Length: 0
Content-Type: application/json; charset=UTF-8
GET请求

要求：有多少数据？ 

curl -i --head  "http://localhost:8888/api/items"

答：横跨29页的576条记录... 

HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 23:17:37 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
X-Pagination-Total-Count: 576
X-Pagination-Page-Count: 29
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 20
Link: <http://localhost:8888/api/items?page=1>; rel=self, <http://localhost:8888/api/items?page=2>; rel=next, <http://localhost:8888/api/items?page=29>; rel=last
Content-Type: application/json; charset=UTF-8

要求：给我显示记录15： 

curl -i  "http://localhost:8888/api/items/15"

响应： 

HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 23:19:27 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Content-Length: 203
Content-Type: application/json; charset=UTF-8

{"id":15,"title":"Jeff Reifman","path":"jeffreifman",
"detail":"","status":0,"posted_by":1,"image_url":"",
"favorites":0,"stat_1":0,"stat_2":0,"stat_3":0,"created_at":1477277956,"updated_at":1477277956}

要求：请显示第3页上的所有数据： 

curl -i -H "Accept:application/json"
    "http://localhost:8888/api/items?page=3"

响应： 

HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 23:30:21 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
X-Pagination-Total-Count: 575
X-Pagination-Page-Count: 29
X-Pagination-Current-Page: 3
X-Pagination-Per-Page: 20
Link: <http://localhost:8888/api/items?page=3>; rel=self, <http://localhost:8888/api/items?page=1>; rel=first, <http://localhost:8888/api/items?page=2>; rel=prev, <http://localhost:8888/api/items?page=4>; rel=next, <http://localhost:8888/api/items?page=29>; rel=last
Content-Length: 3999
Content-Type: application/json; charset=UTF-8

[{"id":43,"title":"_jannalynn","path":"_jannalynn",
"detail":"","status":0,"posted_by":1,"image_url":"",
"favorites":0,"stat_1":0,"stat_2":0,"stat_3":0,
...
...
...
{"id":99,"title":"alibrown","path":"alibrown","detail":"",
"status":0,"posted_by":1,"image_url":"","favorites":0,
"stat_1":0,"stat_2":0,"stat_3":0,"created_at":1477277956,
"updated_at":1477277956}]
删除请求

这是GET请求的示例，然后是DELETE请求，然后是后续失败的GET尝试： 

$ curl -i -H "Accept: application/json" "http://localhost:8888/api/items/8"
HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 23:32:17 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Content-Length: 186
Content-Type: application/json; charset=UTF-8

{"id":8,"title":"aaker","path":"aaker","detail":"","status":0,"posted_by":1,"image_url":"","favorites":0,"stat_1":0,"stat_2":0,"stat_3":0,"created_at":1477277956,"updated_at":1477277956}

$ curl -i -H "Accept: application/json" -X DELETE "http://localhost:8888/api/items/8"
HTTP/1.1 204 No Content
Date: Tue, 25 Oct 2016 23:32:26 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Content-Length: 0
Content-Type: application/json; charset=UTF-8

$ curl -i -H "Accept: application/json" "http://localhost:8888/api/items/8"
HTTP/1.1 404 Not Found
Date: Tue, 25 Oct 2016 23:32:28 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Content-Length: 115
Content-Type: application/json; charset=UTF-8

{"name":"Not Found","message":"Object not found: 8","code":0,"status":404,"type":"yii\\web\\NotFoundHttpException"}

请求删除的记录返回404错误。

POST请求

对于发帖请求，我切换到了Chrome Postman应用程序 ：

使用Yii2 Chrome目录邮递员扩展程序登陆页面进行编程

注册邮递员很容易：

使用Yii2 Postmand进行注册

然后，我可以在更友好的GUI中向我的本地主机API提交请求：

使用Postman UX中显示的Yii2 POST请求进行编程

然后，我通过curl检索了数据， record 577 ： 

$ curl -i -H "Accept: application/json" "http://localhost:8888/api/items/577"
HTTP/1.1 200 OK
Date: Tue, 25 Oct 2016 23:40:44 GMT
Server: Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.12 PHP/7.0.10 mod_ssl/2.2.31 OpenSSL/1.0.2h DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0
X-Powered-By: PHP/7.0.10
Content-Length: 219
Content-Type: application/json; charset=UTF-8

{"id":577,"title":"Jeff Reifman","path":"reifman",
"detail":"A programmer on earth.","status":0,
"posted_by":1,"image_url":"","favorites":0,
"stat_1":0,"stat_2":0,"stat_3":0,"created_at":1477436477,
"updated_at":1477436477}

事实证明，Postman对于完善我的测试至关重要，因为对于POST提交而言，配置命令行卷曲并不容易。

展望未来

除了REST快速入门概述之外 ，Yii 2.0文档还提供了有关API创建的其他方面的详细信息：

我希望将来有机会探索更多这些内容。 但是可以肯定的是，下一步之一就是在启动系列中为Meeting Planner创建一个API。

最后，使用Yii MVC框架构建基本的REST API非常简单。 Yii团队在一项非常重要的需求REST API的标准化功能方面做得很好。 希望您喜欢这些知识。

如果您有任何问题或建议，请在评论中发布。 如果您想了解我将来的Envato Tuts +教程和其他系列，请访问我的讲师页面或关注@reifman 。 一定要检查一下我的启动系列和Meeting Planner 。

相关链接

翻译自: https://code.tutsplus.com/tutorials/programming-with-yii2-building-a-restful-api--cms-27513

cunjie3951
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
yii2.0 基于RESTful的接口的几种请求方式, 举例说明
daxia_85的博客
02-03 5711
yii2.0 基于RESTful的接口的几种请求方式
Yii2框架构建高性能restful接口
06-16
通过本系列课程的学习，达到可以用Yii2自主构建一套高效的、稳定的、高扩展性restful api的能力。并且，通过本课程学习，开发者可以充分的理解Yii2接口的灵活性，其中包括：按需取值，自由扩展，标准统一的接口开发...
Yii API接口工作开发
vv___的博客
05-10 980
概述：Yii是提供一种restful风格的接口开发，可以使用这个，也可以不进行使用，我想的是不进行使用。 如果是yii2 RESTful api提供的，直接进行配置就好，但是我不太想使用，原因有二，一是他是应该没办法自己定义请求接口url，二是他没办法对字段什么进行处理，好像直接就返回整个model了。 如果自己定义的话，有以下几个步骤 yii2迁移数据库 配置控制器 配置Url规则 其他进阶操作 整体看起来还是比较简单的。 参考： yii2 RESTful api的详细使用_基础 ...
推荐一款强大的Yii2 RESTful API模板：Michaelweixi的Yii2-RESTful-API-Template
最新发布
gitblog_00054的博客
04-20 232
推荐一款强大的Yii2 RESTful API模板：Michaelweixi的Yii2-RESTful-API-Template 项目地址:https://gitcode.com/michaelweixi/Yii2-RESTful-API-Template 项目简介 在软件开发中，API（应用程序编程接口）扮演着至关重要的角色，特别是在构建现代Web服务和移动应用时。Yii2-RESTful-AP...
Yii2启动Restful风格Api接口，用于前后端分离项目或者对外的第三方Api接口
qq_38828542的博客
05-22 209
使用高级Yii2模板：yii2-app-advanced 原因：建立Restful的Api相当于一个独立的项目，如backend(后端)、frontend(前端)，又因为Api与后端项目相识度高，只是封装方法对外暴露，因此需要复制一份backend，重命名为api项目，放在根目录，与backend、frontend、common等同级。 一、准备工作  1、下载安装集成工具，如 wampServ...
Yii2实现RESTful API
buyue
12-06 522
复制yii2原项目的frontend目录，重命名成api， common/config/bootstrap.php <?php /** * 定义别名 */ Yii::setAlias('@common', dirname(__DIR__)); $_root = dirname(dirname(__DIR__)); //api Yii::setAlias('@api', $_root...
【yii2】RESTful接口实现
梦想小镇
03-24 1046
需要使用的和创建的文件 controllers/api/ProductController.php <?php /** * Created by PhpStorm. * User: zhudechao * Date: 2019/3/24 * Time: 上午11:03 */ namespace app\controllers\api; use app\mod...
yii2 api开发进阶
Robin罗兵
02-14 874
一、如何实现id转换为关联表中的字段 重写模型类的fields或extraFields方法,根据需求设置字段以及字段的值，这样，yii\rest\Serializer转换出来的数组就是我们需要的数据了 A、在客户端发送的api请求地址上，通过fields参数来指定需要的字段。 B、我们重写fields方法来指定需要的字段，还可以自定义字段名。 C、在fields方法中，通过匿名函数自定义字段的...
diogen:使用 angular-kickstart 构建的 Angular + Yii 2 rest API renga 诗歌应用程序
07-14
《构建Angular + Yii 2 RESTful API的Renga诗歌应用：深入探讨diogen项目》 在Web开发领域，Angular框架以其强大的MVC架构和丰富的功能，成为构建前端应用的首选工具之一。与此同时，Yii 2作为PHP领域的高性能框架...
prog_web:使用框架进行 Web 编程
06-22
本篇文章将深入探讨“prog_web:使用框架进行Web编程”这一主题，主要关注PHP框架在构建Web应用程序中的应用。 一、PHP框架的引入 PHP框架为开发者提供了标准的结构和最佳实践，简化了代码组织，减少了重复工作。...
yii2中文开发手册
09-26
总之，“yii2中文开发手册”和“yii2英文开发手册”是开发者在Yii2框架下进行Web开发的必备参考，它们详细地解释了框架的每一个部分，帮助开发者高效地利用Yii2构建高性能、可维护的Web应用。无论是初学者还是有经验...
Yii2 RESTful中api的使用及开发实例详解
10-22
主要介绍了Yii2 RESTful中api的使用及开发实例详解的相关资料,需要的朋友可以参考下
Yii2框架RESTful API 格式化响应，授权认证和速率限制三部分详解
12-18
之前写过一篇Yii2框架制作RESTful风格的API快速入门教程，今天接着来探究一下Yii2 RESTful的格式化响应，授权认证和速率限制三个部分 一、目录结构 先列出需要改动的文件。目录如下： web ├─ common │ └─ models │ └ User.php └─ frontend ├─ config │ └ main.php └─ controllers └ BookController.php 二、格式化响应 Yii2 RESTful支持JSON和XML格式，如果想指定返回数据的格式，需要配置yii\filters\ContentNegotiator::formats属
yii2-advanced-api, 具有 RESTful API设置的Yii2高级模板.zip
09-18
yii2-advanced-api, 具有 RESTful API设置的Yii2高级模板 2高级应用程序模板中的 rest APIYii2高级应用程序模板，配置了 RESTful API 。 查看 http://budiirawan.com/setup-restful-api-yii2/ 了解更详细的解释安装 Compose
yii2的restful api路由实例详解
01-02
yii\rest\UrlRule 使用yii\rest\UrlRule来自动映射控制器的 restful 路由，简单快捷，缺点是必须得按规定好的方法名去写业务。 映射的规则如下，当然，你可以修改源码为你的习惯： public $patterns = [ 'PUT,PATCH {id}' => 'update', 'DELETE {id}' => 'delete', 'GET,HEAD {id}' => 'view', 'POST' => 'create', 'GET,HEAD' => 'index', '{id}' => 'options', '' => 'op
php-yii-api.zip
03-20
7. **Web 服务支持**：Yii 提供了对 RESTful Web 服务的良好支持，可以方便地构建 API 应用，这正是 "php-yii-api.zip" 文件可能关注的部分。 8. **性能优化**：Yii 内置了优化工具，例如页面级和操作级别的缓存，...
yii2 api开发进阶
kfgauss的博客
08-05 158
魏曦视频差不多的几个博客。 yii2 api开发进阶 https://blog.csdn.net/lyb8010/article/details/87250454 YII2 advanced 高级版本项目搭建-添加API应用以及多应用 https://blog.csdn.net/qq_21956483/article/details/80742970 Yii2.0 快速搭建Restful...
YII2 restful 试例
z330249949的专栏
01-12 8280
config['composer'] 的urlManager 配置'urlManager' => [ 'class' => 'yii\web\UrlManager', 'enablePrettyUrl' => true, // 'enableStrictParsing' => true, 'showScriptName' => fal
php restful yii,yii2 restful 风格搭建(一)
weixin_26873711的博客
03-11 138
最近在研究 yii2 如何搭建 restful api，将心得写下，欢迎一起讨论使用yii2.0.13 advanced 版，将 frontend 整个作为 api 接口项目，除了接口的路由规则可以认证通过外，其他的路由规则都返回请求错误的格式1、数据库结构CREATE TABLE `goods` (`id` int(11) unsigned NOT NULL AUTO_INCREMENT,`na...
Learning Yii Testing(PACKT,2015)
05-13
Testing your application often and early is a key consideration in modern web development. PHP developers using the high-performance PHP framework Yii have access to Codeception, a testing suite that provides comprehensive support for unit, functional, and acceptance tests. With Codeception, you will quickly learn how to create fast, stable applications using a test-driven development methodology. Learning Yii Testing embraces a testing-first strategy to guide you in the implementation of all possible types of tests, covering the core features of Yii 2. Starting with the nuts and bolts of testing, you'll walk through Yii 2's new functionality and improvements and learn how to begin testing with it. You'll explore the world of Codeception and gain insights into key topics such as testing in isolation and component integration tests.

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值