首页 >后端开发 >php教程 >使用 Lithe 和 Eloquent 创建迷你博客 API

使用 Lithe 和 Eloquent 创建迷你博客 API

Linda Hamilton
Linda Hamilton原创
2024-11-30 10:56:10494浏览

Creating a Mini Blog API with Lithe and Eloquent

第 1 步:安装 Lithe

第一步是在您的项目中安装Lithe。如果您还没有这样做,只需在终端中运行以下命令:

composer create-project lithephp/lithephp mini-blog-api

此命令使用 Lithe 创建一个新项目。 Lithe 会自动为您配置 Eloquent,但我们需要调整 .env 文件中的一些设置来连接数据库。


第 2 步:配置数据库

现在,让我们配置数据库。打开项目根目录下的 .env 文件并编辑数据库设置。要将 Eloquent ORMMySQL 一起使用,设置应如下所示:

DB_CONNECTION_METHOD=eloquent
DB_CONNECTION=mysql
DB_HOST=localhost
DB_NAME=lithe_eloquent
DB_USERNAME=root
DB_PASSWORD=
DB_SHOULD_INITIATE=true

由于 Lithe 自动配置 Eloquent,下一步是确保安装 Eloquent ORM。如果您还没有这样做,请运行以下命令来安装 Eloquent ORM:

composer require illuminate/database

安装后,Lithe 将准备好使用 Eloquent ORM 并与数据库交互。这样,数据库现在就已为我们的 迷你博客 API 正确配置了!


第 3 步:为帖子创建模型和迁移

现在,让我们创建模型和迁移来定义数据库中的 posts 表。

首先,使用以下命令创建 Post 模型:

php line make:model Post

接下来,为 posts 表创建迁移:

php line make:migration create_posts_table

模型和迁移现已创建。让我们配置它们。

帖子模型

Post 模型位于 src/models/Post.php。像这样编辑文件:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    // The table associated with the model
    protected $table = 'posts';

    // Fields that can be filled via mass-assignment
    protected $fillable = ['title', 'content'];

    // Use timestamps for created_at and updated_at
    public $timestamps = true;
}

在此代码中,我们将标题和内容字段定义为可填写,这意味着它们可以在创建或更新帖子时自动填充。

帖子表迁移

生成的迁移将位于 src/database/migrations/{timestamp}_create_posts_table.php 中。编辑迁移以创建 posts 表的结构:

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Capsule\Manager as Capsule;

return new class
{
    public function up(): void
    {
         Capsule::schema()->create('posts', function (Blueprint $table) {
            $table->id(); // Creates the auto-incrementing id field
            $table->string('title'); // Creates the title field
            $table->text('content'); // Creates the content field
            $table->timestamps(); // Creates created_at and updated_at fields
        });
    }

    public function down(): void
    {
         Capsule::schema()->dropIfExists('posts');
    }
};

在这里,我们正在创建包含字段 id、标题、内容以及日期时间字段created_at 和updated_at 的posts 表。


第 4 步:运行迁移

准备好迁移和模型后,让我们运行迁移以在数据库中创建 posts 表。执行以下命令:

php line migrate

此命令将使用我们在迁移中定义的字段在数据库中创建 posts 表。


第 5 步:创建后置控制器

现在,让我们创建一个控制器来管理API的帖子。控制器将负责处理 HTTP 请求并以有组织的方式返回数据。

要创建控制器,请执行:

composer create-project lithephp/lithephp mini-blog-api

这将在 src/http/Controllers/PostController.php 中生成一个文件。编辑此文件以包含帖子的 CRUD(创建、读取、更新和删除)方法。

这是 PostController 的示例:

DB_CONNECTION_METHOD=eloquent
DB_CONNECTION=mysql
DB_HOST=localhost
DB_NAME=lithe_eloquent
DB_USERNAME=root
DB_PASSWORD=
DB_SHOULD_INITIATE=true

这里,我们有五种基本方法:

  • 索引:列出所有帖子。
  • show:显示特定帖子。
  • 商店:创建一个新帖子。
  • 更新:更新现有帖子。
  • destroy:删除帖子。

第 6 步:定义 API 路由

现在,让我们定义 post API 的路由。打开文件 src/App.php 并添加以下代码:

composer require illuminate/database

上面的代码创建了 Lithe 应用程序的实例。 $app->set('routes', __DIR__ . '/routes'); 行告诉 Lithe 在哪里可以找到路由文件。 Lithe 会自动加载 src/routes 文件夹中的所有文件。每个路由文件将根据其名称映射到 URL。例如:

  • 文件 cart.php 将转到 /cart 路由。
  • 文件 admin/dashboard.php 将转到 /admin/dashboard 路由。

行 $app->listen();使 Lithe “监听”请求,即等待传入请求并将它们定向到定义的路由。

现在,在 src/routes/posts 文件夹中创建一个名为 posts.php 的文件来表示 /posts 路由,并添加以下代码:

php line make:model Post

这些路由将 PostController 中的方法连接到 API URL。


第 7 步:测试 API

现在一切都已设置完毕,您可以使用 PostmanInsomnia 等工具测试您的 API。以下是您可以测试的端点:

  • GET /posts:返回所有帖子。
  • GET /posts/:id:返回特定帖子。
  • POST /posts:创建新帖子。
  • PUT /posts/:id:更新现有帖子。
  • DELETE /posts/:id:删除帖子。

现在,您刚刚使用 LitheEloquent ORM 创建了一个 迷你博客 API! Lithe 会自动为您设置 Eloquent,我们只需对环境变量进行一些调整并创建必要的模型和控制器。现在您拥有完整的 RESTful API 来管理博客文章。

有关如何使用 LitheEloquent ORM 的更多信息和详细信息,请访问此处的 Lithe 官方文档:Lithe 文档。

以上是使用 Lithe 和 Eloquent 创建迷你博客 API的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn