Yii2.0 RESTful API 基础配置教程详解-6ren

Yii2.0 RESTful API 基础配置教程详解

转载作者：qq735679552 更新时间：2022-09-29 22:32:09

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Yii2.0 RESTful API 基础配置教程详解由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

最近在做Yii2.0 RESTful API功能，找了好久的资料，才找到这类的教程，感谢该作者，以下内容根据我的项目实际情况做了一定的修改.

安装yii2.0 。

安装 Composer 后，您可以通过在 Web 可访问的文件夹下运行以下命令来安装Yii应用程序模板:

composer create-project --prefer-dist yiisoft/yii2-app-basic basic

初始化高级模板。

cd advanced./init

输入"./init"后会出现以下内容。

Yii Application Initialization Tool v1.0 。

Which environment do you want the application to be initialized in？

[0] Development [1] Production 。

Your choice [0-1, or "q" to quit] 0 。

Initialize the application under 'Development' environment? [yes|no] yes 。

Start initialization ... 。

修改数据库连接属性。

打开 commonconfigmain-local.php,配置数据库连接信息。

'db' => [      'class' => 'yii\db\Connection',      'dsn' => 'mysql:host=127.0.0.1;dbname=yii',      'username' => 'root',      'password' => 'root',      'charset' => 'utf8',    ],

执行 migrate 数据库迁移。

./yii migrate

拷贝backend目录，命名为api 。

打开apiconfigmain.php 修改id,controllerNamespace等，将所有backend替换为api:

return [  'id' => 'app-api',  'basePath' => dirname(__DIR__),  'controllerNamespace' => 'api\controllers',]

打开apiconfigmain.php开启url路由美化规则。

'urlManager' => [      'enablePrettyUrl' => true,      'showScriptName' => false,      'rules' => [      ],    ],

打开commonconfigbootstrap.php添加以下别名。

Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');

为什么要单独创建API应用。

单独创建API应用，目的是便于维护，可以避免以下问题。

配置的冲突
控制器的命名不便
url美化规则冲突
分工明确frontend为前台目录；backend为后台目录；api为api目录

接下来打开 apicontrollers 新建一个User控制器，继承 yiirestActiveController，命名为 UserController,代码如下:

<?phpnamespace api\controllers;use yii\rest\ActiveController;class UserController extends ActiveController{  public $modelClass = 'common\models\User';  }

配置URL规则。

为刚才的 user控制器添加url美化规则。

打开 apiconfigmain.php 修改 components属性，添加下列代码

...'urlManager' => [  'enablePrettyUrl' => true,  'enableStrictParsing' => true,  'showScriptName' => false,  'rules' => [    ['class' => 'yii\rest\UrlRule',     'controller' => 'user'    ],  ],]...

ok，到此就成了一个符合 RESTful 风格的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 支持的动词

如何访问呢。

你可以使用 curl命令进行访问,命令如下

curl -i -H "Accept:application/json" http://localhost/users

命令行下还是比较麻烦的，也不方便测试，推荐使用 API测试工具。

这类的工具有很多，我就不一一列举了，这里推荐 Postman,很好很强大，Chorme也有插件，可以安装，这里我推荐直接下载软件安装调试，比较方便。

你可能发现了访问任何路由地址都是加的s,users ，为什么呢? 资源，你要理解资源二字，既然是资源肯定是个集合，肯定有一大堆，所以要加上复数，我是这么理解的.

你说我就是不想加上s,我就想采用http://localhost/user 这种方式来进行访问，好吧，可以，满足你，只是不推荐。

继续打开配置文件apiconfigmain.php修改刚才添加的 urlManager 如下

'urlManager' => [  'enablePrettyUrl' => true,  'enableStrictParsing' => true,  'showScriptName' => false,  'rules' => [    ['class' => 'yii\rest\UrlRule',     'controller' => 'user',    'pluralize' => false,  //设置为false 就可以去掉复数形式了    ],  ],]

加入 'pluralize' => false, 就表示去掉复数形式了，再次强调不推荐。

ok，在控制器中我们没有写任何一句代码，他就给我们生成许多方法，但是有时候我们可能需要修改一些代码，来达到我们想要的效果，比如连表查询，然后再返回数据。

接下来我们就实现这样的功能

打开刚才新建的user控制器, 重写 action方法

<?phpnamespace api\controllers;use yii\rest\ActiveController;class UserController extend extends ActiveController{  public $modelClass = 'common\models\User';    public function actions()  {    $action= parent::actions(); // TODO: Change the autogenerated stub    unset($action['index']);    unset($action['create']);    unset($action['update']);    unset($action['delete']);  }    public function actionIndex()  {    //你的代码  }  }

这样我们就可以重写他的代码了。哈哈。

我们再新建一个自己的 action 。

<?phpnamespace api\controllers;use yii\rest\ActiveController;class UserController extends ActiveController{  public $modelClass = 'common\models\User';    public function actions()  {    $action= parent::actions(); // TODO: Change the autogenerated stub    unset($action['index']);    unset($action['create']);    unset($action['update']);    unset($action['delete']);  }    public function actionIndex()  {    //你的代码  }    public function actionTest() //假如是get请求  {    //业务逻辑  }  }

然后试着访问一下 http://localhost/users/test，报错？找不到?

报错就对了，那是因为我们没有设置其他路由访问。

修改 apiconfigmain.php 。

'urlManager' => [  'enablePrettyUrl' => true,  'enableStrictParsing' => true,  'showScriptName' => false,  'rules' => [    ['class' => 'yii\rest\UrlRule',     'controller' => 'user',    //'pluralize' => false,  //设置为false 就可以去掉复数形式了    'extraPatterns'=>[      'GET send-email'=>'test'    ],    ],  ],]

接下来重新访问就没有问题了，ps：你自己编写的任何 action 都要在 extraPatterns 进行配置。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我.

最后此篇关于Yii2.0 RESTful API 基础配置教程详解的文章就讲到这里了,如果你想了解更多关于Yii2.0 RESTful API 基础配置教程详解的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！。

文章推荐： CI框架实现创建自定义类库的方法

文章推荐： asp.net 上传图片并同时生成缩略图的代码

文章推荐： asp.net ListView交替背景颜色实现代码

教程
我正在做一个关于代码学院的教程，我在这里收到一个错误，说“看起来你的函数没有返回‘唉，你没有资格获得信用卡。资本主义就是这样残酷。’”当收入参数为 75 时。”但是该字符串在控制台中返回(由于某种原因
Go 教程 : Channels, Buffered Channels 教程
我正在阅读 Go 的官方教程，但很难理解 Channel 和 Buffered Channels 之间的区别。教程的链接是 https://tour.golang.org/concurrency/2和
MSHTML 教程
就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the
LinqPad 教程
关闭。这个问题是off-topic .它目前不接受答案。想改进这个问题？ Update the question所以它是on-topic对于堆栈溢出。 9年前关闭。 Improve this que
JavaSpaces 教程
已关闭。此问题不符合Stack Overflow guidelines 。目前不接受答案。要求我们推荐或查找工具、库或最喜欢的场外资源的问题对于 Stack Overflow 来说是偏离主题的，因为
iOS5高级编程书籍/教程
作为 iOS 新手，有大量书籍可以满足学习基础知识的需求。现在，我想转向一些高级阅读，例如 OAuth 和 SQLite 以及动态 API 派生的 TableView 等。您可以推荐任何资源吗？最佳
Selenium 教程
就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the
Android开源游戏引擎+教程
关闭。这个问题是opinion-based .它目前不接受答案。想要改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它. 关闭 8 年前。 Improve
c - 教程
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭 8 年前。
【教程】AWD中如何通过Python批量快速管理服务器？
前言很多同学都知道，我们常见的CTF赛事除了解题赛之外，还有一种赛制叫AWD赛制。在这种赛制下，我们战队会拿到一个或多个服务器。服务器的连接方式通常是SSH链接，并且可能一个战队可能会同时有
1、Memcached 教程
Memcached是一个自由开源的，高性能，分布式内存键值对缓存系统 Memcached 是一种基于内存的key-value存储，用来存储小块的任意数据（字符串、对象），这些数据可以是数据库调用、A
01、Perl 教程
Perl 又名实用报表提取语言，是 Practical Extraction and Report Language 的缩写 Perl 是由拉里·沃尔（Larry Wall）于19
01、WSDL 教程
WSDL 是 Web Services Description Language 的缩写，翻译成中文就是网络服务描述语言 WSDL 是一门基于 XML 的语言，用于描述 Web Services 以
Perl UMMF 教程？
关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。 6年前关闭。 Improve thi
用于创建自定义用户控件的 WPF 教程
我正在寻找解释在 WPF 中创建自定义用户控件的教程。我想要一个控件，它结合了一个文本 block 、一个文本框和一个启动通用文件打开对话框的按钮。我已经完成了布局，一切都连接好了。它有效，但它是三
sdk - dynamodb 教程
就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the
Django 教程，后退按钮混淆
我接近 fourth page of the Django tutorial 的开始看着vote查看，最后是这样的: # Always return an HttpResponseRedirect a
emacs - ClojureBox 教程
就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the
Qt QSS 教程
是否有任何好的 Qt QSS 教程，或者在某个地方我可以看到样式小部件的示例？如果某处可用，我想要一些完整的引用。除了有关如何设置按钮或某些选项卡样式的小教程外，我找不到任何其他内容。最佳答案 Qt
ASP.NET 教程
就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持，但这个问题可能会引起辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the he

qq735679552

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

Yii2.0 RESTful API 基础配置教程详解