第四节：dingo/API 最新版 V2.0 之 Responses （连载）

Posted jingying

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了第四节：dingo/API 最新版 V2.0 之 Responses （连载）相关的知识，希望对你有一定的参考价值。

因为某些某些原因，不能按时更新，唉。我会尽力，加快速度。（这句话不是翻译的哈）

原文地址——> https://github.com/dingo/api/wiki/Responses

A functioning API is built upon receiving requests and returning a consumable response to the client. An API will generally return responses in an easy to consume format such as JSON. There‘s a number of different ways to return responses and it will largely depend on how complex your API is or will become.

一个运行的API 主要是获取请求并返回给客户端响应信息。一个API通常会以一种易于使用的格式返回响应，例如JSON。这是一个不同的方法去返回请求。这里有许多不同的方法可以返回响应，很大程度上取决于您的API的复杂程度或者API未来的方向。

The easiest way to return a consumable response is to simply return an array or object directly from your controller. Not every object can be correctly formatted though so you should ensure that it implements either the ArrayObject or the Illuminate\Support\Contracts\ArrayableInterface interface.

返回一个可使用的响应最简单的方式是直接从控制器返回数组或对象。不是每个对象都能够被返回正确的格式，但因此，你应该确定它继承了ArrayObject或者Illuminate\Support\Contracts\ArrayableInterface接口。

 

class UserController
{
    public function index()
    {
        return User::all();
    }
}

在这个实例中，我们的User类继承了Illuminate\Database\Eloquent\Model，意味着它能作为一个格式化的数组返回，所以我们能通过调用User::all(),简单的返回一个users集合。

同样的，你也能使用它返回一个单一的user。例：如下

class UserController
{
    public function show($id)
    {
        return User::findOrFail($id);
    }
}

 

这个包，将自动格式化响应信息之后作为JSON格式返回，并且为Content-Type 头设置为application/json。 

 

Response Builder  响应构建器

这个响应构建器，提供一个流畅的接口去简单的生成一个定制的响应信息。这个响应构建器通常与transformers结合使用。

要想在你的控制器，使用这个响应返回。你应该引入（使用） Dingo\Api\Routing\Helpers。为了让你的全部控制器都可以用使用这个特性，你应该创建一个基类控制器，让你所有的控制器都去继承（extends）它。

use Dingo\Api\Routing\Helpers;
use Illuminate\Routing\Controller;

class BaseController extends Controller
{
    use Helpers;
}

 

现在，你的控制器能简单的继承基本控制器。在你的控制器中可以经由$response属性来访问响应构建器。

关于这，更详细的文档，你应该看Transformers那节。（接下来，我会慢慢翻译的，等。。）

Responding With An Array 作为一个数组返回

class UserController extends BaseController
{
    public function show($id)
    {
        $user = User::findOrFail($id);

        return $this->response->array($user->toArray());
    }
}

 Responding With A Single Item 作为一个item返回

class UserController extends BaseController
{
    public function show($id)
    {
        $user = User::findOrFail($id);

        return $this->response->item($user, new UserTransformer);
    }
}

Responding With A Collection Of Items 作为一个元素集合返回

class UserController extends BaseController
{
	public function index()
	{
		$users = User::all();

		return $this->response->collection($users, new UserTransformer);
	}
}

　　

Responding With Paginated Items    返回带分页的数组

class UserController extends BaseController
{
    public function index()
    {
        $users = User::paginate(25);

        return $this->response->paginator($users, new UserTransformer);
    }
}

Responding With No Content     无内容响应

return $this->response->noContent();

Responding With Created Response    创建了资源的响应

return $this->response->created();

你也可以，为这个created 随意的提供一个值，作为第一个参数。

return $this->response->created($location);　　

Responding With An Error 返回一个错误提示

这个包内有很多不同的响应错误的提示，你可以快速的形成一个错误提示。（这块文字理解，我感觉不太好，就把真实的返回值写出来了）

return $this->response->error(‘This is an error.‘, 404);
返回信息：{"message":"This is an error.","status_code":404}

return $this->response->errorNotFound();
返回信息：{"message":"Not Found","status_code":404} 

return $this->response->errorBadRequest();
返回信息：{"message":"Bad Request","status_code":400}

return $this->response->errorForbidden();

返回信息：{"message":"Forbidden","status_code":403}

 

return $this->response->errorInternal();

返回信息：{"message":"Internal Error","status_code":500}

 

return $this->response->errorUnauthorized();

返回信息：{"message":"Unauthorized","status_code":401}

 

Adding Additional Headers      添加附加的表头

一旦您使用了上述方法中的一个，您就可以通过添加附加的表头来进一步定制响应。

return $this->response->item($user, new UserTransformer)->withHeader(‘X-Foo‘, ‘Bar‘);

Adding Meta Data   添加元数据

某些转化层可能会使用元数据（meta data）。当你需要提供与资源相关的额外数据时，这很有用。

return $this->response->item($user, new UserTransformer)->addMeta(‘foo‘, ‘bar‘);

你也可以设置一个 meta 数据的数组，省得多次调用 addMeta 方法。

return $this->response->item($user, new UserTransformer)->setMeta($meta);

Setting Response Status Code    设置返回值状态

return $this->response->item($user, new UserTransformer)->setStatusCode(200);

　　　　

Custom Response Formats    自定义响应格式

在这个配置章节，我们简单的讲解了返回信息格式。通过这个dingo包，我们将自动的使用json格式，并设置一个恰当的Content-Type头。除了 JSON 格式化，还有一个 JSONP 格式化。这个 formatter 将会用一个回调包裹响应。更改格式只需要简单将配置文件（Laravel）或启动文件（Lumen）中的默认JSON格式替换成JSONP即可：

‘formats‘ => [
    ‘json‘ => ‘Dingo\Api\Http\Response\Format\Jsonp‘
]

 或

Dingo\Api\Http\Response::addFormatter(‘json‘, new Dingo\Api\Http\Response\Format\Jsonp);

 你可以注册之后使用你自己需要的格式。你的格式应该继承 Dingo\Api\Http\Response\Format\Format。这有很多请求应该被定义：formatEloquentModel，formatEloquentCollection，formatArray和getContentType。

Morphing And Morphed Events   

 在发送一个响应之前，它会改变它，在发送。这个过程包括运行所有转换器（Transformer）以及通过配置的响应格式发送响应。如果你需要对响应的变化有更多的控制，你可以使用 ResponseWasMorphed 和 ResponseIsMorphing 这两个事件.

在你的app/Listeners文件夹，创建一个监听器。

use Dingo\Api\Event\ResponseWasMorphed;

class AddPaginationLinksToResponse
{
	public function handle(ResponseWasMorphed $event)
	{
		if (isset($event->content[‘meta‘][‘pagination‘])) {
			$links = $event->content[‘meta‘][‘pagination‘][‘links‘];

			$event->response->headers->set(
				‘link‘,
				sprintf(‘<%s>; rel="next", <%s>; rel="prev"‘, $links[‘links‘][‘next‘], $links[‘links‘][‘previous‘])
			);
		}
	}
}

　然后通过在EventServiceProvider中注册事件及其对应监听器来监听该事件：

protected $listen = [
    ‘Dingo\Api\Event\ResponseWasMorphed‘ => [
        ‘App\Listeners\AddPaginationLinksToResponse‘
    ]
];

 Now all responses that contain pagination links will also add these links to the Link header.(这句话，留给你们翻译)

这章结束了，马上要2018年了。新的一年，go go go !!!







以上是关于第四节：dingo/API 最新版 V2.0 之 Responses （连载）的主要内容，如果未能解决你的问题，请参考以下文章

dingo/API 最新版 V2.0 之安装讲解

laravel Passport - 创建 REST API 用户认证以及Dingo/Api v2.0+Passport实现api认证

《Pro Android Graphics》读书笔记之第四节

Angular最新教程-第四节详细说明初始化项目

第四节：web爬虫之urllib

《Pro Android Graphics》读书笔记之第四节