简单的API响应。

dev-master 2016-03-21 06:54 UTC

This package is not auto-updated.

Last update: 2024-09-30 00:42:08 UTC


README

安装

首先,使用Composer拉取此包。

"require": {
    "gouravbajaj0210/api": "dev-master"
},
  "repositories": [
    {
        "type": "git",
        "url": "https://gouravbajaj0210@bitbucket.org/gouravbajaj0210/api-package.git"
    }
    ],

然后,在 config/app.php 中包含服务提供者。

'providers' => [
    gouravbajaj0210\api\ApiProvider::class
];

为了方便,将门面别名添加到该文件的底部

'aliases' => [
    'api' => gouravbajaj0210\api\ApiFacade::class
];

通过运行此Artisan命令发布配置

php artisan vendor:publish

用法

  • api::success(['data'=>'随机数据'])
  • api::notFound(['errorMsg'=> '用户未找到'])
  • api::notAuth(['errorMsg'=> '用户未授权'])
  • api::notValid(['errorMsg'=> '邮箱字段是必需的'])
  • api::serverError(['errorMsg'=> '出了些问题'])

或者,您可以引用 api() 助手函数,而不是门面。这里有一个例子

api()->success(['data' => 'some data']);
api()->notFound(['errorMsg' => 'something nto found']);

或者,对于成功的API响应,只需这样做:api(['data' => '一些信息']);

方法链

您可以利用方法链。

#!php

api()->data(['data'=> 'my data'])->statusCode(201)->success();
api()->json()->notFound();