如何将数据库Schema转换为包含迁移、模型、接口的Lumen API

前置准备 #

确保你已经完成Lumen项目初始化，.env文件内的数据库连接参数已正确配置。

步骤1：创建Migration迁移文件 #

迁移文件用于生成数据库表结构，你需要对照你的Schema字段编写对应迁移逻辑：

1. 执行命令生成迁移文件模板：

php artisan make:migration create_xxx_table

将xxx替换为你实际的表名。
2. 编辑生成的迁移文件（路径database/migrations/[生成的文件名]），参考示例调整字段：

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up()
    {
        Schema::create('xxx', function (Blueprint $table) {
            $table->id();
            // 对照你的Schema添加对应字段，比如：
            // $table->string('name');
            // $table->integer('age')->nullable();
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::dropIfExists('xxx');
    }
};

3. 执行迁移命令生成表：

php artisan migrate

步骤2：创建Model模型 #

模型用于和数据库表做映射，在app/Models目录下新建对应模型文件，比如Xxx.php：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Xxx extends Model
{
    // 对应表名
    protected $table = 'xxx';
    // 允许批量赋值的字段，按你实际字段调整
    protected $fillable = [
        'name',
        'age'
    ];
    // 需要隐藏的字段
    protected $hidden = [
        'password'
    ];
}

步骤3：编写API接口 #

3.1 注册路由 #

编辑routes/web.php文件，添加接口路由：

$router->group(['prefix' => 'api'], function () use ($router) {
    // 获取列表
    $router->get('xxx', 'XxxController@index');
    // 获取单条详情
    $router->get('xxx/{id}', 'XxxController@show');
    // 新增数据
    $router->post('xxx', 'XxxController@store');
    // 更新数据
    $router->put('xxx/{id}', 'XxxController@update');
    // 删除数据
    $router->delete('xxx/{id}', 'XxxController@delete');
});

如果要单独用api.php路由文件，需要在bootstrap/app.php中添加路由加载逻辑：

$app->router->group([
    'namespace' => 'App\Http\Controllers',
], function ($router) {
    require __DIR__.'/../routes/api.php';
});

3.2 编写控制器 #

在app/Http/Controllers目录下新建XxxController.php：

<?php

namespace App\Http\Controllers;

use App\Models\Xxx;
use Illuminate\Http\Request;

class XxxController extends Controller
{
    // 获取列表
    public function index()
    {
        return response()->json(Xxx::all());
    }

    // 获取单条详情
    public function show($id)
    {
        return response()->json(Xxx::findOrFail($id));
    }

    // 新增数据
    public function store(Request $request)
    {
        $this->validate($request, [
            // 按你实际字段加校验规则，比如：
            'name' => 'required|string|max:255'
        ]);
        $data = Xxx::create($request->all());
        return response()->json($data, 201);
    }

    // 更新数据
    public function update(Request $request, $id)
    {
        $item = Xxx::findOrFail($id);
        $item->update($request->all());
        return response()->json($item);
    }

    // 删除数据
    public function delete($id)
    {
        Xxx::findOrFail($id)->delete();
        return response()->json(null, 204);
    }
}

效率提升建议 #

你可以安装第三方生成器扩展快速生成上述代码：

1. 安装扩展：

composer require flipbox/lumen-generator

2. 在bootstrap/app.php中注册服务提供者：

$app->register(Flipbox\LumenGenerator\LumenGeneratorServiceProvider::class);

3. 之后就可以用命令快速生成模型、控制器等，比如：

php artisan make:model Xxx -mc

这条命令会自动生成对应模型、迁移文件和控制器。

内容的提问来源于stack exchange，提问作者user10496245