首頁 > 後端開發 > php教程 > 使用 Lithe 和 Eloquent 建立迷你部落格 API

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

Barbara Streisand
發布: 2024-11-30 10:08:11
原創
814 人瀏覽過

Criando uma API de Mini Blog com Lithe e Eloquent

在本教程中,我們將使用簡單靈活的PHP 框架Lithe 建立一個迷你部落格API,以及Eloquent ORM ,方便與資料庫的互動。 Lithe 已經自動配置了 Eloquent,所以我們需要做的工作很簡單:調整環境變數並為我們的資料建立模型和遷移。

讓我們按照簡單的分步指南高效且輕鬆地建立此 API。


第 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 表。

首先,使用以下指令建立貼文範本:

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
{
    // A tabela associada ao modelo
    protected $table = 'posts';

    // Campos que podem ser preenchidos via mass-assignment
    protected $fillable = ['title', 'content'];

    // Usar timestamps para created_at e updated_at
    public $timestamps = true;
}
登入後複製
登入後複製

在此程式碼中,我們將標題和內容欄位定義為可填寫,這意味著當我們建立或更新貼文時可以自動填充它們。

貼文表格遷移

產生的遷移將位於 src/database/migrations/{timestamp}_create_posts_table.php 中。編輯遷移以建立 posts 表結構:

composer create-project lithephp/lithephp mini-blog-api
登入後複製
登入後複製

在這裡,我們正在建立貼文表,其中包含欄位 id、標題、內容以及日期和時間欄位created_at 和updated_at。


第 4 步:運行遷移

準備好遷移和模型後,讓我們運行遷移以在資料庫中建立 posts 表。執行以下命令:

DB_CONNECTION_METHOD=eloquent
DB_CONNECTION=mysql
DB_HOST=localhost
DB_NAME=lithe_eloquent
DB_USERNAME=root
DB_PASSWORD=
DB_SHOULD_INITIATE=true
登入後複製
登入後複製

此命令將使用我們在遷移中定義的欄位在資料庫中建立 posts 表。


第 5 步:為貼文建立控制器

現在,讓我們建立一個控制器來管理API貼文。控制器將負責以有組織的方式處理 HTTP 請求並傳回資料。

要建立控制器,請執行:

composer require illuminate/database
登入後複製
登入後複製

這將在 src/http/Controllers/PostController.php 產生一個檔案。編輯此文件以包含帖子的 CRUD(創建、讀取、更新和刪除)方法。

以下是 PostController 的範例:

php line make:model Post
登入後複製
登入後複製

這裡,我們有五種基本方法:

  • 索引:列出所有帖子。
  • show:顯示特定帖子。
  • 商店:建立一個新帖子。
  • 更新:更新現有貼文。
  • destroy:刪除帖子。

第 6 步:定義 API 路由

現在,讓我們定義貼文 API 的路由。開啟 src/App.php 檔案並新增以下程式碼:

php line make:migration create_posts_table
登入後複製
登入後複製

上面的程式碼建立了 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 路由,並新增以下程式碼:

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    // A tabela associada ao modelo
    protected $table = 'posts';

    // Campos que podem ser preenchidos via mass-assignment
    protected $fillable = ['title', 'content'];

    // Usar timestamps para created_at e updated_at
    public $timestamps = true;
}
登入後複製
登入後複製

這些路由將 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中文網其他相關文章!

來源:dev.to
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板