Laravel 5.5中为响应请求提供的可响应接口详解

前言

Laravel 5.5 也将会是接下来的一个 LTS（长期支持）版本。 这就意味着它拥有两年修复以及三年的安全更新支持。Laravel 5.1 也是如此，不过它两年的错误修复支持将在今年结束。

Laravel 5.5 的路由中增加了一种新的返回类型：可相应接口( Responsable )。该接口允许对象在从控制器或者闭包路由中返回时自动被转化为标准的 HTTP 响应接口。任何实现 Responsable 接口的对象必须实现一个名为 toResponse() 的方法，该方法将对象转化为 HTTP 响应对象。

看示例：

use Illuminate\Contracts\Support\Responsable;

class ExampleObject implements Responsable
{
 public function __construct($name = null)
 {
  $this->name = $name ?? 'Teapot';
 }

 public function status()
 {
  switch(strtolower($this->name)) {
   case 'teapot':
    return 418;
   default:
    return 200;
  }
 }

 public function toResponse()
 {
  return response(
   "Hello {$this->name}",
   $this->status(),
   ['X-Person' => $this->name]
  );
 }
}

在路由中使用这个 ExampleObject 的时候，你可以这样做：

Route::get('/hello', function() {
 return new ExampleObject(request('name'));
});

在 Laravel 框架中， Route 类如今可以在准备响应内容时检查这种（实现了 Responsable 接口的）类型：

if ($response instanceof Responsable) {
 $response = $response->toResponse();
}

假如你在 App\Http\Responses 命名空间下用多个响应类型来组织你的响应内容，可以参考下面这个示例。该示例演示了如何支持 Posts （多个实例组成的 Collection）:

posts = $posts;
 }

 public function toResponse()
 {
  return response()->json($this->transformPosts());
 }

 protected function transformPosts()
 {
  return $this->posts->map(function ($post) {
   return [
    'title' => $post->title,
    'description' => $post->description,
    'body' => $post->body,
    'published_date' => $post->published_at->toIso8601String(),
    'created' => $post->created_at->toIso8601String(),
   ];
  });
 }
}

以上只是一个模拟简单应用场景的基础示例：返回一个 JSON 响应，但你希望响应层不是简单地用内置实现把对象 JSON 化，而是要做一些内容处理。以上示例同时假设 App\Http\Responses\Response 这个类能提供一些基础的功能。当然响应层也可以包含一些转换代码（类似 Fractal），而不是直接在控制器里做这样的转换。

与上面示例中的 PostIndexResponse 类协作的控制器代码类似以下这样：

如果你想了解更多有关这个接口的细节，可以查看项目中 相关代码的 commit.

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对我们的支持。

赞 (0)

相关推荐

  • PHP使Laravel为JSON REST API返回自定义错误的问题

    我正在开发某种RESTful API.发生一些错误时,我会抛出一个App :: abort($code,$message)错误. 问题是:我希望他用键"代码"和"消息"抛出一个json形成的数组,每个数组都包含上述数据. Array ( [code] => 401 [message] => "Invalid User" ) 有没有人知道是否可能,如果是,我该怎么做? 去你的app / start / global.php. 这将将40

  • php使用百度翻译api示例分享

    百度翻译API的PHP代码,测试可以实现,不过英译中可能需要转换编码. 复制代码 代码如下: <?phpfunction language($value,$from="auto",$to="auto"){  $value_code=urlencode($value);  #首先对要翻译的文字进行 urlencode 处理  $appid="YourApiKey";  #您注册的API Key  $languageurl = "ht

  • Laravel框架实现调用百度翻译API功能示例

    本文实例讲述了Laravel框架实现调用百度翻译API功能.分享给大家供大家参考,具体如下: 前言 最近在弄的视频下载网站,弄seo是人工去google翻译,然后再保存,这样下去很累啊,然后就想到让程序自己去翻译然后保存不就行了嘛,自己主要把中文的seo搞定就OK了.说干就干,最先去找了google 翻译 api,可惜要绑定信用卡,太麻烦,放弃,然后找到百度翻译API,虽然支持的国外语言不多,但最基本的国家也都有了.ok,开始撸码. 代码说明 使用的是Laravel框架,语言包存放在resour

  • 基于Laravel Auth自定义接口API用户认证的实现方法

    基于Laravel Auth自定义接口API用户认证的实现方法

    基于 laravel 默认的 auth 实现 api 认证 现在微服务越来越流行了. 很多东西都拆分成独立的系统,各个系统之间没有直接的关系. 这样我们如果做用户认证肯定是统一的做一个独立的 用户认证 系统,而不是每个业务系统都要重新去写一遍用户认证相关的东西. 但是又遇到一个问题了. laravel 默认的auth 认证 是基于数据库做的,如果要微服务架构可怎么做呢? 实现代码如下: UserProvider 接口: // 通过唯一标示符获取认证模型 public function retri

  • ThinkPHP调用百度翻译类实现在线翻译

    要实现ThinkPHP在线翻译功能,需要先在百度开发者中心注册一个API key,具体实现代码如下: action代码部分: <?php class FanyiAction extends Action { public function _empty(){ header("HTTP/1.0 404 Not Found"); $this->display("Public:404"); } public function index() { $User =

  • Laravel框架实现修改登录和注册接口数据返回格式的方法

    本文实例讲述了Laravel框架实现修改登录和注册接口数据返回格式的方法.分享给大家供大家参考,具体如下: 1.背景:需要将所有的数据返回格式统一成retCode/retMsg/data 2.登陆接口: 文件目录:app/Http/Controllers/Auth/LoginController 先写登陆接口是因为修改登录接口比注册接口要简单许多 登录接口中的第一句 use AuthenticatesUsers; 可以进去修改登录验证内容(默认是email+password登录),可以修改 va

  • 让Laravel API永远返回JSON格式响应的方法示例

    让Laravel API永远返回JSON格式响应的方法示例

    json格式 JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式,易于阅读和编写,同时也易于机器解析和生成.它基于ECMA262语言规范(1999-12第三版)中JavaScript编程语言的一个子集. JSON采用与编程语言无关的文本格式,但是也使用了类C语言(包括C, C++, C#, Java, JavaScript, Perl, Python等)的习惯,这些特性使JSON成为理想的数据交换格式. 本文将给大家详细介绍关于让Laravel API永

  • 基于laravel制作APP接口（API）

    基于laravel制作APP接口（API）

    前期准备 前言,为什么做以及要做个啥 本人姓小名白,不折不扣编程届小白一名,但是自从大一那会儿接触到编程这件奇妙的事情,就完完全全的陷入的程序的世界. 这不,最近又开始折腾APP了,话说现在开发一款APP真是容易,只用JavaScript和一点点HTML+css技术就可以完成.但是做APP的后台就不一样了.开发了APP,想让读点数据进去,那我们就要去开发个后台了. laravel框架,是我最喜欢的PHP框架了,没有之一.去年就曾经用laravel写了我的个人网站但粗糙程度让我十分脸红,好了不扯了

  • 详解Laravel5.6 Passport实现Api接口认证

    很多企业做项目使用前后端分离,后端提供接口地址,前端使用接口地址拿数据,并渲染页面.那么,前端用户登录如何使用接口进行认证?网上各种教程写的不堪入目,完全看不懂,所以我根据自己的理解,写下此篇文章,希望能帮助到大家. 后端(Laravel5.6框架) 1.使用 composer 安装 Passport ,打开终端,执行命令: composer require laravel/passport #安装完成后,在composer.json文件中会看到文件版本信息 2.接下来,将 Passport 的

  • 详解laravel安装使用Passport(Api认证)

    Laravel通过传统的登录表单已经让用户认证变得很简单,但是API怎么办?API通常使用token进行认证并且在请求之间不维护session状态.Laravel使用Laravel Passport让API认证变得轻而易举,Passport基于Alex Bilbie维护的League OAuth2 server,可以在数分钟内为Laravel应用提供完整的OAuth2服务器实现. 中文文档 http://laravelacademy.org/post/6813.html 安装 composer

  • Laravel+Dingo/Api 自定义响应的实现

    在最近的开发开发项目中,我使用了Dingo/Api这个第三方Api库. Dingo是个很强大的Api库, 但在开发的过程中,需要自定义响应字段. 刚开始使用Ding/Api时,返回如下: { "message": "422 Unprocessable Entity", "errors": { "mobile": [ "手机号格式不正确" ] }, "status_code": 422 }

随机推荐