README

Laravel REST API 生成器

根据数据库模式生成 REST API 项目的代码框架。此包也可在 packagist 上找到。通过 packagist 安装是首选方式。

示例

GitHub 上有两个开源的 REST API 项目，使用此生成器开发

安装

包安装

在您的 composer.json (require 部分) 中添加 "tmphp/rest-api-generators": "dev-master"
在您的 composer.json 中设置 "minimum-stability": "dev"
运行 composer update

配置

打开您的 config/app.php 并在 providers 部分添加此行

TMPHP\RestApiGenerators\GeneratorsServiceProviders::class,
Dingo\Api\Provider\LaravelServiceProvider::class,
Way\Generators\GeneratorsServiceProvider::class,
Xethron\MigrationsGenerator\MigrationsGeneratorServiceProvider::class,
Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,
L5Swagger\L5SwaggerServiceProvider::class,
Abhijitghogre\LaravelDbClearCommand\LaravelDbClearCommandServiceProvider::class,
Felixkiss\UniqueWithValidator\ServiceProvider::class,

发布配置文件

执行命令

php artisan vendor:publish

打开您的 config/jwt.php 并更改用户模型命名空间的那一行。

'user' => 'App\REST\User',

配置 .env 文件

设置到数据库的正确连接
添加 dingo/api 包的配置。有关详细信息，请参阅此处文档
必需的配置字符串是 API_DOMAIN=yourdomain.dev

注册中间件

将中间件添加到 App/Http/Kernel.php 的 $routeMiddleware 数组中。

'check.role.access' => \TMPHP\RestApiGenerators\Middleware\CheckAccess::class,

Swagger 配置

在 'config/l5-swagger.php' 中添加 '/routes' 路径，注释路径。

'annotations' => [base_path('app'), base_path('routes')],

数据库模式

确保您已创建数据库模式。为了生成关系，您应该有 FOREIGN KEY 约束。

为 REST API 项目生成代码

运行 artisan 命令进行代码框架。

php artisan make:rest-api-project

生成 Swagger 文档。

php artisan l5-swagger:generate

执行命令

composer dump-autoload

🐘 💥 👍 👍

tmphp / rest-api-generators

维护者

详情