yii2 restful web服务[格式响应]

版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/dcj3sjt126com/article/details/84688735

响应格式

当处理一个 RESTful API 请求时, 一个应用程序通常需要如下步骤 来处理响应格式:

  1. 确定可能影响响应格式的各种因素, 例如媒介类型, 语言, 版本, 等等。 这个过程也被称为 content negotiation
  2. 资源对象转换为数组, 如在 Resources 部分中所描述的。 通过 [[yii\rest\Serializer]] 来完成。
  3. 通过内容协商步骤将数组转换成字符串。 [yii\web\ResponseFormatterInterface|response formatters]] 通过 [yii\web\Response::formatters|response]] 应用程序组件来注册完成。

内容协商

Yii 提供了通过 [[yii\filters\ContentNegotiator]] 过滤器支持内容协商。RESTful API 基于 控制器类 [[yii\rest\Controller]] 在contentNegotiator 下配备这个过滤器。 文件管理器提供了涉及的响应格式和语言。 例如, 如果一个 RESTful API 请求中包含以下 header,

Accept: application/json; q=1.0, */*; q=0.1

将会得到JSON格式的响应,如下:

$ curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "http://localhost/users"

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
X-Powered-By: PHP/5.4.20
X-Pagination-Total-Count: 1000
X-Pagination-Page-Count: 50
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 20
Link: <http://localhost/users?page=1>; rel=self,
      <http://localhost/users?page=2>; rel=next,
      <http://localhost/users?page=50>; rel=last
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

[
    {
        "id": 1,
        ...
    },
    {
        "id": 2,
        ...
    },
    ...
]

幕后,执行一个 RESTful API 控制器动作之前,[[yii\filters\ContentNegotiator]] filter 将检查 Accept HTTP header 在请求时和配置 [[yii\web\Response::format|response format]] 为 'json'。 之后的动作被执行并返回得到的资源对象或集合, [[yii\rest\Serializer]] 将结果转换成一个数组。最后,[[yii\web\JsonResponseFormatter]] 该数组将序列化为JSON字符串,并将其包括在响应主体。

默认, RESTful APIs 同时支持JSON和XML格式。为了支持新的格式,你应该 在 contentNegotiator 过滤器中配置 [[yii\filters\ContentNegotiator::formats|formats]] 属性, 类似如下 API 控制器类:

use yii\web\Response;

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_HTML;
    return $behaviors;
}

formats 属性的keys支持 MIME 类型,而 values 必须在 [[yii\web\Response::formatters]] 中支持被响应格式名称。

数据序列化

正如我们上面所描述的,[[yii\rest\Serializer]] 负责转换资源的中间件 对象或集合到数组。它将对象 [[yii\base\ArrayableInterface]] 作为 [[yii\data\DataProviderInterface]]。 前者主要由资源对象实现, 而 后者是资源集合。

你可以通过设置 [[yii\rest\Controller::serializer]] 属性和一个配置数组。 例如,有时你可能想通过直接在响应主体内包含分页信息来 简化客户端的开发工作。这样做,按照如下规则配置 [[yii\rest\Serializer::collectionEnvelope]] 属性:

use yii\rest\ActiveController;

class UserController extends ActiveController
{
    public $modelClass = 'app\models\User';
    public $serializer = [
        'class' => 'yii\rest\Serializer',
        'collectionEnvelope' => 'items',
    ];
}

那么你的请求可能会得到的响应如下 http://localhost/users:

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
X-Powered-By: PHP/5.4.20
X-Pagination-Total-Count: 1000
X-Pagination-Page-Count: 50
X-Pagination-Current-Page: 1
X-Pagination-Per-Page: 20
Link: <http://localhost/users?page=1>; rel=self,
      <http://localhost/users?page=2>; rel=next,
      <http://localhost/users?page=50>; rel=last
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "items": [
        {
            "id": 1,
            ...
        },
        {
            "id": 2,
            ...
        },
        ...
    ],
    "_links": {
        "self": "http://localhost/users?page=1",
        "next": "http://localhost/users?page=2",
        "last": "http://localhost/users?page=50"
    },
    "_meta": {
        "totalCount": 1000,
        "pageCount": 50,
        "currentPage": 1,
        "perPage": 20
    }
}
展开阅读全文

搭配修身写一个RESTful Web服务

12-09

在站长中心这里,你了解什么是REST和它是如何工作的。在这篇文章中,我想向您展示如何创建一个RESTful Web服务,使用超薄,PHP微框架西纳特拉,Ruby框架的启发。它非常适合创建简单的RESTful Web服务和像路由器,请求,响应,并查看一些最起码的组件。很简单,很容易理解和使用。rn斯利姆世界问好rn要获得修身开始,你需要先下载它。它需要PHP 5.2 +,让你写在这两个程序的风格,或5.3 +风格的应用程序,例如使用匿名函数。在本文中我将使用所有的例子5.3作风编码,假设你已经熟悉它了。rn要创建一个Hello World应用程序,删除默认的index.php文件在应用程序目录,并创建一个新的index.php文件用下面的代码:rnrn01 get("/", function () rn09 echo " Hello Slim World";rn10 );rn11 rn12 // run the Slim apprn13 $app->run();rnrn现在是准备你的第一个修身应用。如果你通过浏览器访问index.php文件,你应该看到一个大的“Hello斯利姆世界。”rn在您的应用程序中使用的Slim,你需要包括Slim.php和斯利姆,会自动加载,它需要的所有其他文件。然后,您可以创建一个或多个实例修身对象,并添加您的路线。rn苗条的构造函数接受一个应用程序的配置值的数组。模式,TEMPLATES.PATH和观看一些重要的,我们经常使用的配置。使用模式设置要像开发或生产,使用的应用环境。TEMPLATES.PATH设置使用模板文件的位置。斯利姆使用Slim_View的,默认情况下,呈现的观点,但您可以编写自定义的视图处理程序,并通过使用附加苗条价值。下面的示例演示如何创建一个新的自定义修身实例TEMPLATES.PATH和设置环境的发展模式。rnrn1 "development",rn4 "TEMPLATES.PATH' => "./templates"rn5 ));rnrn创建一个应用程序使用斯利姆是创建路线的最重要组成部分。路由帮助一个URI映射到一个特定的请求方法的回调函数。斯利姆提供一个简单而直观的方式,以相同的URI映射的方法不同的要求。它将调用的回调函数,符合当前的URI和请求方法,或产生一个404错误,如果它是无法比拟的。加入航线后,你需要调用的run()方法修身实例运行的应用程序。rn写一个图书馆服务rn在更深入的运动,让我们创建一个简单的图书馆管理Web服务应用程序使用超薄。在此应用中,我们就可以列出,添加,删除,更新本书详细介绍了使用Web服务调用。rn下表列出了将支持Web服务的端点:rn对于数据库的交互中,我将使用NotORM书面JakubVrána作为替代ORM,它提供了一个简单而直观的API来与数据库中的数据,PHP库。NotORM使用PHP的PDO扩展来访问数据库,所以PDO的实例传递给NotORM的构造。rnrn1 "developement",rn05 "TEMPLATES.PATH' => "./templates"rn06 );rn07 rn08 $app->get("/books", function () use ($app, $db) rn09 $books = array();rn10 foreach ($db->books() as $book) rn11 $books[] = array(rn12 "id" => $book["id"],rn13 "title" => $book["title"],rn14 "author" => $book["author"],rn15 "summary" => $book["summary"]rn16 );rn17 rn18 $app->response()->header("Content-Type", "application/json");rn19 echo json_encode($books);rn20 );rnrn()是修身的方法,路线到指定的URI上的GET请求。它的第一个参数是URI和最后一个参数是一个回调函数。使用关键字,使我们能够从匿名函数的范围内访问外部变量。rn在函数中,我们创建,遍历数据库返回的每个记录(书的数组$ DB->图书()返回一个遍历参考的书籍表)。发送响应的Content-Type头为“应用程序/ json”我们发出的编码书数据阵列。rn现在让我们写一本书与一个给定的ID的详细信息端点:rnrn01 get("/book/:id", function ($id) use ($app, $db) rn04 $app->response()->header("Content-Type", "application/json");rn05 $book = $db->books()->where("id", $id);rn06 if ($data = $book->fetch()) rn07 echo json_encode(array(rn08 "id" => $data["id"],rn09 "title" => $data["title"],rn10 "author" => $data["author"],rn11 "summary" => $data["summary"]rn12 ));rn13 rn14 elsern15 echo json_encode(array(rn16 "status" => false,rn17 "message" => "Book ID $id does not exist"rn18 ));rn19 rn20 );rnrn在这里,我们添加了一个参数,本书的ID传递路线。在执行这条路线,斯利姆将调用的回调函数作为参数的参数值。rn请注意该参数是强制性的。您可以通过它放在像括号内可选:/书(/ ID),如果你正在做一个参数可选,不过,你将不能够指定的回调函数的参数。在这种情况下,你可以使用func_get_args()以任何参数传递给回调函数来获得。rn添加和编辑书籍rn现在,让我们的地址端点添加和更新图书信息负责。我们将使用后()方法来添加新的数据,并把()来更新现有的数据。rnrn01 post("/book", function () use($app, $db) rn04 $app->response()->header("Content-Type", "application/json");rn05 $book = $app->request()->post();rn06 $result = $db->books->insert($book);rn07 echo json_encode(array("id" => $result["id"]));rn08 );rn09 rn10 $app->put("/book/:id", function ($id) use ($app, $db) rn11 $app->response()->header("Content-Type", "application/json");rn12 $book = $db->books()->where("id", $id);rn13 if ($book->fetch()) rn14 $post = $app->request()->put();rn15 $result = $book->update($post);rn16 echo json_encode(array(rn17 "status" => (bool)$result,rn18 "message" => "Book updated successfully"rn19 ));rn20 rn21 elsern22 echo json_encode(array(rn23 "status" => false,rn24 "message" => "Book id $id does not exist"rn25 ));rn26 rn27 );rnrn为应用程序请求()返回当前请求对象(Slim_Http_Request的使用POST)或把数据。你可以得到的POST值员额()这个对象的方法,使用()方法的沽值。在这里,我们假设两个POST和PUT数据信息表的列名作为键的键/值对。在现实世界的应用程序,你将需要添加一些验证和错误处理,但我已经为简单起见,这里省略。rn如果你打算从浏览器访问您的修身应用,你将不能够很容易地使PUT请求,浏览器通常不公开通过HTML的方法。为了克服这个问题,修身有一个规定,它可以让你覆盖POST请求将放置在一个隐藏字段的形式。字段的名称应该是“_method”设置为“PUT”的价值。rnrn1 rn2 rn3 Title: rn4 Author: rn5 Summary: rn6 rn7 rn8 rnrn删除书籍rn我们需要的下一个显而易见的事情,现在我们有添加,编辑和书单,在我们的Web服务端点,端点删除书籍。它应该接受书要删除的ID,并从数据库中删除相应的记录。rn01 delete("/book/:id", function ($id) use($app, $db) rn04 $app->response()->header("Content-Type", "application/json");rn05 $book = $db->books()->where("id", $id);rn06 if ($book->fetch()) rn07 $result = $book->delete();rn08 echo json_encode(array(rn09 "status" => true,rn10 "message" => "Book deleted successfully"rn11 ));rn12 rn13 elsern14 echo json_encode(array(rn15 "status" => false,rn16 "message" => "Book id $id does not exist"rn17 ));rn18 rn19 );rn一切都非常简单。首先,我们取给定的ID从数据库中相应的行,就像我们已经做了的时候本书详细介绍了。行对象上调用的delete()方法从数据库中删除该记录。rn我们已经建立了相关的所有书籍进行必要的终点。在某些情况下,您可能希望有一个单一的路线,将响应多个请求方法。它可以实现使用的地图()的斯利姆方法。rn rn总结rn rn在这篇文章中,我们已经讨论了创建一个RESTful Web服务,使用超薄框架。现在,你应该能够创建自己的Web服务应用程序,没有太多的麻烦。rn当然,也有很多事情比这里讨论的简单的事情可以做。你可以有很多参数,数据验证等航线。因此,深入和喜欢苗条和NoORM来帮助你实现你的目标使用的工具。rnrn 论坛

没有更多推荐了,返回首页