Yii2.0 RESTful Web服务(4)

路由

随着资源和控制器类准备,您可以使用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‘],
    ],
]

将enablePrettyUrl设置为true,譬如访问www.xxxxx.com时不会直接显示www.xxxxx.com/site/index.php
而是需要在rules中增加对应的配置。

将enableStrictParsing设置为true,该项表示访问的Url必须至少匹配一个路由规则,否则认定为无效,且在设置enablePrettyUrl为true后生效。

将showScriptName设置为true,表示在Url保留入口脚本index.php。

相比于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 and PUT
    /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‘],
],

如果UserController是继承自ActiveController,对应的方法的禁用也可以通过yii\rest\ActiveController::actions()方法声明(Yii2.0
RESTful Controller相关

您也可以通过配置 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 属性。

yii\rest\UrlRule::controller的值在通常情况下是直接使用了urlManager中配置在rules中的user为前缀,当然Yii2.0也提供了两种自定义方式,一种是传入键值对数组譬如将yii\rest\UrlRule::controller赋值为"[‘u‘
=> ‘user‘ ]" 这样后续的访问则将u视为控制器id,另外一种则是输入一个数组譬如"[‘user‘, ‘player‘]" 这样就会生成所有传入值对应的路由规则。Yii在路由规则这边采用了一种比较简单的的方式进行处理,如果采用简单粗暴的方式,Yii完全可以牺牲一定的开发便利性,在代码层面提高路由规则的性能,例如直接采用正则表达式的方式,但是Yii没有这样做。Yii在urlManager::init()的时候对所有路由进行了缓存,很好的稳定了性能与开发便利性。

时间: 2024-10-09 08:46:33

Yii2.0 RESTful Web服务(4)的相关文章

Yii2.0 RESTful Web服务(1)

快速入门 Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API. 特别是,Yii 支持以下关于 RESTful 风格的 API: 支持 Active Record 类的通用API的快速原型 涉及的响应格式(在默认情况下支持 JSON 和 XML) 支持可选输出字段的定制对象序列化 适当的格式的数据采集和验证错误 支持 HATEOAS 有适当HTTP动词检查的高效的路由 内置OPTIONS和HEAD动词的支持 认证和授权 数据缓存和HTTP缓存 速率限制

Yii2.0 RESTful Web服务(2)

资源 RESTful 的 API 都是关于访问和操作资源,可将资源看成MVC模式中的Model 在如何代表一个资源没有固定的限定,在Yii中通常使用 yii\base\Model 或它的子类(如 yii\db\ActiveRecord) 代表资源,是为以下原因: yii\base\Model 实现了 yii\base\Arrayable 接口,它允许你通过RESTful API自定义你想要公开的资源数据. yii\base\Model 支持输入验证, 在你的RESTful API需要支持数据输入

Yii2.0 RESTful Web服务(3)

在创建资源类和指定资源格输出式化后,下一步就是创建控制器操作将资源通过RESTful APIs展现给终端用户. Yii 提供两个控制器基类来简化创建RESTful 操作的工作:yii\rest\Controller 和 yii\rest\ActiveController, 两个类的差别是后者提供一系列将资源处理成ActiveRecord(关于ActiveRecord)的操作. 因此如果使用ActiveRecord内置的操作会比较方便,可考虑将控制器类 继承yii\rest\ActiveContr

Yii2快速构建RESTful Web服务功能简介

Yii2相比Yii1而言,一个重大的改进是内置了功能完备的RESTful支持. 其内置RESTful支持提供了如下功能: 使用ActiveRecord的通用接口来快速构建原型: 应答格式协商(缺省支持 JSON 和 XML): 可定制的对象序列化,支持选择输出哪些列: 请求数据的格式化以及验证错误: 通过HTTP 动词映射实现高效路由: 支持 OPTIONS 和 HEAD 动词: 认证 和 鉴权: 支持 HATEOAS(RESTful的架构约束,超媒体即应用程序状态): 结果缓存,可使用 yii

使用 Jersey 和 Apache Tomcat 构建 RESTful Web 服务

RESTful Web 服务简单介绍 REST 在 2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之中的一个. REST 中最重要的概念是资源(resources),使用全球 ID(通常使用 URI)标识. client应用程序使用 HTTP 方法(GET/ POST/ PUT/ DELETE)操作资源或资源集.RESTful Web 服务是使用 HTTP 和 REST 原理实现的 Web 服务.通常,RESTful Web 服

[译]Spring Boot 构建一个RESTful Web服务

翻译地址:https://spring.io/guides/gs/rest-service/ 构建一个RESTful Web服务 本指南将指导您完成使用spring创建一个“hello world”RESTful Web服务的过程. 你将会构建什么 您将构建一个将接受HTTP GET请求的服务: 您将构建一个将接受HTTP GET请求的服务: http://localhost:8080/greeting 1 1 并且使用JSON的形式进行响应: {"id":1,"conten

分享一个Android和java调用RESTful Web服务的利器Resting

分享一个Android和java调用RESTful Web服务的利器Resting 当我们调用Web服务,往往是最终目标是取HTTP响应,将其转化为将在应用中呈现的值对象.Resting可以用来实现这一功能.Resting,在Java的一个轻量级的REST框架,可用于调用一个RESTful Web服务,并转换成响应来自客户端应用程序定制的Java对象.由于它的简单,resting是适合Android等手持设备. resting目标?暴露简单的get(),post(),put()和delete()

基于jersey和Apache Tomcat构建Restful Web服务(一)

基于jersey和Apache Tomcat构建Restful Web服务(一) 现如今,RESTful架构已然成为了最流行的一种互联网软件架构,它结构清晰.符合标准.易于理解.扩展方便,所以得到越来越多网站的采用.那么问题来了,它是什么呢? 起源 REST(Representational state transfer)在 2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之一. REST 中最重要的概念是资源(resources

基于jersey和Apache Tomcat构建Restful Web服务(二)

基于jersey和Apache Tomcat构建Restful Web服务(二) 上篇博客介绍了REST以及Jersey并使用其搭建了一个简单的“Hello World”,那么本次呢,再来点有趣的东西,当然也是很简单了,仅仅是在路径中包含参数而已了.接下来开始动手实践吧. 在路径中包含参数 接下来就在上次的基础上进行改动即可,或者是再添加一个方法,随意了,这个方法主要就是在路径中加入输入的参数,并且根据参数的不同,它的返回值也不同,返回值为“Hello”+你输入的参数.这里用到了“PathPar