echo-it/laravel-jsonapi

v2.4.2 2015-10-29 10:11 UTC

README

!!! 项目已废弃。请查看 cloudcreativity/laravel-json-api 以获取优秀的替代方案。

Laravel 5 的 JSON API 帮助库

Build Status

轻松创建符合 jsonapi.org 的 API

此库努力与最新的 JSON API 更新保持同步——因为规范仍在发展中。如果您发现缺少某些功能,请贡献您的力量!

安装

  1. echo-it/laravel-jsonapi 添加到您的 composer.json 依赖列表中(最低版本为 2.0.0 以支持 Laravel 5)

  2. 运行 composer update

要求

  • PHP 5.4+
  • Laravel 5

使用 laravel-jsonapi

此库旨在以暴露模型的概念为基础,正如 RESTful API 方法中所发现的那样。

只需几个步骤,您就可以公开您的模型

  1. 创建一个路由来引导请求

    在此示例中,我们使用一个通用的路由来处理所有模型和 HTTP 方法

    Route::any('{model}/{id?}', 'ApiController@handleRequest');
  2. 创建您的控制器以处理请求

    您的控制器负责处理输入、实例化处理类并返回响应。

    
    
调用fulfillRequest(); } catch (ApiException $e) { 返回 $e->response(); } 返回 $res->toJsonResponse(); } // 如果不存在请求模型的处理类,则认为该API未暴露该模型 return new ApiErrorResponse(404, 404, '实体未找到'); } }