asahasrabuddhe/laravel-api

此包最新版本(0.3.4-beta)没有提供许可证信息。

一个使在Laravel(也包括Lumen)中开发API变得非常简单的包


README

一个强大的包,旨在使开发API变得非常简单。此包自动提供对路由、控制器方法和相关逻辑的支持,无需编写样板代码。

请注意,此包仍在开发中,以下文档可能会有变化,可能与先前版本不兼容。请勿在生产环境中使用,直到1.0版本发布。

安装

该包目前正在开发中,因此不在composer中提供。请使用以下方法安装并帮助构建此包。

按照以下步骤在您的Laravel安装中克隆存储库

git clone https://github.com/asahasrabuddhe/laravel-api packages/asahasrabuddhe/laravelapi

在您的composer.json文件中添加以下行以帮助安装包

"repositories": [
        {
            "type": "path",
            "url": "packages/asahasrabuddhe/laravel-api",
            "options": {
                "symlink": true
            }
        }
    ],

然后,在composer文件的require部分添加以下行并运行composer update。

"asahasrabuddhe/laravel-api": "dev-master"

现在您可以使用该包了。

基本用法

  1. 要启用使用此包,请替换以下内容

a. 模型:将所有use Illuminate\Database\Eloquent\Model;实例替换为use Asahasrabuddhe\LaravelAPI\BaseModel;。对于Laravel默认的用户模型,将use Illuminate\Foundation\Auth\User as Authenticatable;替换为use Asahasrabuddhe\LaravelAPI\BaseUser as Authenticatable;

b. 控制器:在您的控制器顶部添加以下行:use Asahasrabuddhe\LaravelAPI\BaseController as Controller

2.路由:请在routes/api.php文件中按以下方式定义路由

ApiRoute::group([
    'middleware' => ['api'],
    'namespace' => 'App\Http\Controllers'], function () {
        ApiRoute::resource('user', 'UserController');
        ApiRoute::resource(<route>, <controller>);
    }
);