使用 Lithe 和 Eloquent 建立迷你部落格 API

第 1 步：安裝 Lithe

第一步是在您的專案中安裝Lithe。如果您還沒有這樣做，只需在終端機中執行以下命令：

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

此指令使用 Lithe 建立一個新專案。 Lithe 會自動為您設定 Eloquent，但我們需要調整 .env 檔案中的一些設定來連接資料庫。

---

第 2 步：設定資料庫

現在，讓我們來設定資料庫。開啟專案根目錄下的 .env 檔案並編輯資料庫設定。將 Eloquent ORM 與 MySQL 一起使用，設定應如下所示：

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

現在一切都已設定完畢，您可以使用 Postman 或 Insomnia 等工具測試您的 API。以下是您可以測試的端點：

• GET /posts：回傳所有貼文。
• GET /posts/:id：傳回特定貼文。
• POST /posts：建立新貼文。
• PUT /posts/:id：更新現有貼文。
• DELETE /posts/:id：刪除貼文。

---

現在，您剛剛使用 Lithe 和 Eloquent ORM 創建了一個 迷你部落格 API！ Lithe 會自動為您設定 Eloquent，我們只需對環境變數進行一些調整並建立必要的模型和控制器。現在您擁有完整的 RESTful API 來管理部落格文章。

有關如何使用 Lithe 和 Eloquent ORM 的更多信息和詳細信息，請訪問此處的 Lithe 官方文檔：Lithe 文檔。

以上是使用 Lithe 和 Eloquent 建立迷你部落格 API的詳細內容。更多資訊請關注PHP中文網其他相關文章！