Lighthouse GraphQL 安裝指南(Laravel)

安裝 Lighthouse

# 安裝 Lighthouse 套件
composer require nuwave/lighthouse

# 如果使用 Laravel 8,建議安裝 Lighthouse v5 版本
composer require nuwave/lighthouse:^5.0

發布設定與 schema 檔案

# 發布預設 GraphQL schema(會建立 graphql/schema.graphql 檔案)
php artisan vendor:publish --tag=lighthouse-schema

# 發布 Lighthouse 設定檔(config/lighthouse.php)
php artisan vendor:publish --tag=lighthouse-config

安裝 GraphQL Playground(可選,用於 API 測試)

# 安裝 GraphQL Playground UI 套件
composer require mll-lab/laravel-graphql-playground

# 發布設定檔(config/graphql-playground.php)
php artisan vendor:publish --tag=graphql-playground-config

開啟 Playground UI

安裝完成後,預設可以透過以下路徑進入 Playground:

http://your-app.test/graphql-playground

⚠️ 若使用 Laravel 10 以上版本,建議改用 GraphiQL 或其他前端工具(如 Postman, Insomnia)測試 GraphQL API,因為 laravel-graphql-playground 目前已經停止維護(最後更新為 2021 年)。


如果需要加上 graphiql(純前端嵌入),也可以改用以下方案:

使用瀏覽器版 GraphiQL(不需要額外安裝)

可以使用以下網址直接開啟 GraphiQL,並指定 GraphQL endpoint:

https://graphiql-online.com/?url=http://your-app.test/graphql