路由
随着资源和控制器类准备,您可以使用URL如 http://localhost/index.php?r=user/create
访问资源,类似于你可以用正常的Web应用程序做法。
在实践中,你通常要用美观的URL并采取有优势的HTTP动词。 例如,请求POST /users
意味着访问user/create
动作。 这可以很容易地通过配置urlManager
应用程序组件来完成 如下所示:
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
],
]
相比于URL管理的Web应用程序,上述主要的新东西是通过RESTful API 请求[[yii\rest\UrlRule]]。这个特殊的URL规则类将会 建立一整套子URL规则来支持路由和URL创建的指定的控制器。 例如, 上面的代码中是大致按照下面的规则:
[
'PUT,PATCH users/<id>' => 'user/update',
'DELETE users/<id>' => 'user/delete',
'GET,HEAD users/<id>' => 'user/view',
'POST users' => 'user/create',
'GET,HEAD users' => 'user/index',
'users/<id>' => 'user/options',
'users' => 'user/options',
]
该规则支持下面的API末端:
-
GET /users
: 逐页列出所有用户; -
HEAD /users
: 显示用户列表的概要信息; -
POST /users
: 创建一个新用户; -
GET /users/123
: 返回用户为123的详细信息; -
HEAD /users/123
: 显示用户 123 的概述信息; -
PATCH /users/123
andPUT /users/123
: 更新用户123; -
DELETE /users/123
: 删除用户123; -
OPTIONS /users
: 显示关于末端/users
支持的动词; -
OPTIONS /users/123
: 显示有关末端/users/123
支持的动词。
您可以通过配置 only
和 except
选项来明确列出哪些行为支持, 哪些行为禁用。例如,
[
'class' => 'yii\rest\UrlRule',
'controller' => 'user',
'except' => ['delete', 'create', 'update'],
],
您也可以通过配置 patterns
或 extraPatterns
重新定义现有的模式或添加此规则支持的新模式。 例如,通过末端 GET /users/search
可以支持新行为 search
, 按照如下配置 extraPatterns
选项,
[
'class' => 'yii\rest\UrlRule',
'controller' => 'user',
'extraPatterns' => [
'GET search' => 'search',
],
您可能已经注意到控制器IDuser
以复数形式出现在users
末端。 这是因为 [[yii\rest\UrlRule]] 能够为他们使用的末端全自动复数化控制器ID。 您可以通过设置 [[yii\rest\UrlRule::pluralize]] 为false 来禁用此行为,如果您想 使用一些特殊的名字您可以通过配置 [[yii\rest\UrlRule::controller]] 属性。
相关推荐
主要介绍了yii2的restful api路由实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
yii2-advanced-api, 具有 RESTful API设置的Yii2高级模板 2高级应用程序模板中的 rest APIYii2高级应用程序模板,配置了 RESTful API 。 查看 http://budiirawan.com/setup-restful-api-yii2/ 了解更详细的解释安装 ...
主要介绍了Yii2 RESTful中api的使用及开发实例详解的相关资料,需要的朋友可以参考下
主要介绍了Yii2.0 RESTful API 基础配置教程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
Yii 2和PHP Web应用程序开发
yii2框架restful url接口,认证内容的开发的分享,后续还有接口多版本控制的内容
今天通过本文给大家讲下Yii2 RESTful的格式化响应,授权认证和速率限制三个部分,对yii2 restful api相关知识感兴趣的朋友一起看看吧
2本yii方面的书,使用yii敏捷开发web应用, cookbook, 都是初学者必备
主要给大家介绍了关于yii2项目实战之restful api授权验证的相关资料,文中介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
Yii-rest-rbac 后台RBAC配置写在前面本篇只讲述如何使用Yii-rest-rbac进行 restful API认证和权限管理,关于原理,请移步(目前未完成)下载安装 composer require clement/yii-rest-rbacor ...创建数据表使用@vendor\\...
请注意,这是: 1 Yii2教程 2 英文版
restful例子
Yii2: 一个现代的PHP开发框架为专业的Web开发设计
本文实例分析了Yii2中Restful API原理。分享给大家供大家参考,具体如下: Yii2 有个很重要的特性是对 Restful API的默认支持, 通过短短的几个配置就可以实现简单的对现有Model的RESTful API 这里通过分析rest部分...
yii2-oauth2-server, 用于实现OAuth2服务器的包装器( https yii2-oauth2-server用于实现OAuth2服务器的包装器( https://github.com/bshaffer/oauth2-server-php 插件)安装安装这里扩展的首选方法是通过 Composer 。...
yii2-beanstalk, Yii2 beanstalk web和控制台组件 yii2-beanstalkYii2 beanstalkd web和控制台组件,它是 pda/pheanstalk服务器顶部的一个接口。 感谢 Paul Annesley 完成这项工作。:如何使用?插件安装与 Composer...