laravel api

Laravel/PHP 後端項目

連結到即時生產版本

歡迎來到我的另一個 API 專案。對於這個項目，我編寫、測試並部署了一個 Laravel 應用程式作為全端專案的一部分，利用了該框架的許多強大功能，包括：

• 外觀和輔助函數；
• 用戶認證和授權；
• 資料庫播種；
• Eloquent ORM 查詢建構器；
• 先進的 API 測試工具。

它是做什麼用的？

此 API 處理與使用者/考生及其考試相關的資料。例如，它允許用戶查看有關考試地點、日期、考生姓名等的資訊。

關於訪問的重要說明

• 確保在對 API 的所有請求中包含Accept: application/json HTTP 標頭。
• 大多數 API 功能僅適用於管理員級使用者。要試驗此應用程序，您可以使用以@v3.admin結尾的電子郵件註冊一個新帳戶，這將為您提供完整的管理員權限。

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

註冊或登入後，您將獲得一個 API 令牌，需要將其附加到您的請求標頭中，以確保完全 CRUD 存取。

可用端點

若要存取每個端點，請將 URI 片段附加到根端點。您可以透過造訪根端點查看更多詳細資訊。

資源	描述	認證/授權
發布/註冊	建立新帳戶。	民眾
發布/登入	登入現有帳戶。	民眾
取得/登出/{id}	註銷（撤銷令牌）。	限登入用戶
取得/考試	顯示所有考試的清單。包括 5 個可選查詢參數。	限管理員
取得/考試/{id}	獲取具體考試。	只能看到自己的考試
PUT /考試/{id}	修改具體考試。	只能編輯自己的考試
取得/考試/搜尋/{名稱}	特定候選者的子字串搜尋。	限管理員
刪除/考試/{id}	刪除考試。	只能刪除自己的考試
取得/用戶	取得所有使用者的列表。	限管理員
取得 /users/{id}/exams	取得用戶所有考試的列表	只能看到自己的考試

主要產品特點

• 以「無伺服器函數」部署在 Vercel 上，利用 PHP 執行時間來處理應用程式的配置。
• 生產部署連結到由不同供應商遠端託管的即時 PSQL 資料庫。
• 富有表現力的 Laravel 特定語法和廣泛的方法鏈接，允許更簡潔的程式碼結構。
• 使用 PHPUnit 和 Laravel 流暢的 JSON 語法（基於閉包和 AssertableJson 類別）以測試驅動程式的方式開發。
• 使用 Github Actions 配置的 CI/CD 工作流程進行自動化測試。
• 使用物件導向的 MVC 模式進行架構設計
• 使用 Sanctum 實現的身份驗證服務
  • 用戶可以註冊並登入。
  • 受保護的路由只能由具有有效 API 令牌的使用者存取。
• 使用 Laravel 的門實現授權服務，這是一種基於閉包的授權方法。
  • 某些操作僅允許具有特定角色（例如管理員狀態）的使用者執行。
• 使用 Eloquent ORM 的關係工具定義的關係和模式約束
• 用於開發和測試的SQLite資料庫。

專案目錄中的主要檔案和資料夾

• ./app 包含應用程式的核心邏輯。
  • /app/Http/Controllers 包含請求處理邏輯。
  • app/Models 包含所有模型類，也是我們指定所有可填入欄位的地方。
  • app/Providers 包含引導整個應用程式的類別。
• ./routes/api.php 是我們簡潔定義所有路由（端點）的地方。
• ./tests/Feature 包含應用程式的所有整合測試。
• ./config/database.php 允許您設定資料庫連線設定。
• ./database 是另一個非常重要的資料夾。
  • ./database/factories 包含用於為資料庫播種的工廠類別。
  • ./database/migrations 允許我們修改資料模型
  • ./databse/seeders 包含透過工廠為資料庫播種的類別。

在本機環境中執行項目

首先，請確保您的電腦上安裝了 PHP 和 Composer。

最低版本要求： PHP ^8.1 ；作曲家 2.5.4 。

1. 分叉並克隆儲存庫。

2. cd 到儲存庫並執行以下 CLI 命令：

    composer update
    composer install
   

3. 將.env.example檔案重新命名為.env ，刪除預設 mysql 連接的變量，並確保添加以下 3 個變數：

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. 若要啟動本機開發伺服器，請執行 Artisan CLI 命令：

    php artisan serve
   

5. 若要執行測試套件，請執行 Artisan CLI 命令：

    php artisan test