0

0

laravel怎么集成Lighthouse包实现GraphQL API_laravel Lighthouse GraphQL API集成方法

穿越時空

穿越時空

发布时间:2025-10-23 11:42:02

|

673人浏览过

|

来源于php中文网

原创

Laravel集成Lighthouse可快速构建GraphQL API,通过Schema定义和指令驱动映射到Eloquent模型。首先用Composer安装nuwave/lighthouse包,自动注册服务提供者;接着发布配置、路由和Schema文件,生成config/lighthouse.php、routes/graphql.php和graphql/schema.graphql;然后在RouteServiceProvider的map方法中引入routes/graphql.php确保路由生效;编辑schema.graphql定义类型与查询,如User类型及users、user查询,利用@all、@find等指令实现自动解析;确保User模型存在并正确命名空间;可选创建自定义Query类处理复杂逻辑;启动服务后通过POST请求访问/graphql端点,使用GraphiQL测试查询;支持@paginate实现分页,@auth结合Sanctum实现认证;整个流程减少手动编写解析器,提升开发效率。

laravel怎么集成lighthouse包实现graphql api_laravel lighthouse graphql api集成方法

Laravel 集成 Lighthouse 包可以快速构建功能强大的 GraphQL API,无需手动编写解析器。Lighthouse 是一个基于 Laravel 的 GraphQL 服务器,通过 Schema 定义和指令驱动的方式,直接将 GraphQL 请求映射到 Eloquent 模型和控制器方法。以下是完整的集成步骤。

安装 Lighthouse 包

在已有 Laravel 项目中,使用 Composer 安装 nuwave/lighthouse 包:

composer require nuwave/lighthouse

安装完成后,Lighthouse 会自动注册服务提供者(在 Laravel 5.5+ 中支持包发现)。

发布配置和路由文件

执行以下命令发布 Lighthouse 的配置文件和默认的 GraphQL 路由:

php artisan vendor:publish --tag=lighthouse-config
php artisan vendor:publish --tag=lighthouse-schema
php artisan vendor:publish --tag=lighthouse-views

这会在项目中生成:

  • config/lighthouse.php:主配置文件
  • routes/graphql.php:GraphQL 路由
  • graphql/schema.graphql:主 Schema 文件

配置 GraphQL 路由

确保 routes/graphql.php 已被加载。在 app/Providers/RouteServiceProvider.phpmap() 方法中添加:

public function map()
{
    $this->mapApiRoutes();
    $this->mapWebRoutes();
    // 添加这一行
    require base_path('routes/graphql.php');
}

默认情况下,GraphQL 端点为 /graphql,可通过 POST 请求访问。

定义 GraphQL Schema

编辑 graphql/schema.graphql 文件,定义类型和查询。例如,假设有一个 User 模型:

type User {
  id: ID!
  name: String!
  email: String!
  created_at: DateTime!
}

type Query {
  users: [User!]! @all
  user(id: ID @eq): User @find
}

这里使用了 Lighthouse 内置指令:

  • @all:获取全部记录
  • @find:根据 ID 查找
  • @eq:用于字段条件匹配

这些指令会自动绑定到 Eloquent 查询,无需写 resolver。

启用模型和数据库

确保 User 模型存在并正确配置。Lighthouse 默认使用 Laravel 的 Eloquent 模型,因此只要模型可访问,Schema 就能映射。

知了zKnown
知了zKnown

知了zKnown:致力于信息降噪 / 阅读提效的个人知识助手。

下载

如果需要自定义逻辑,可以创建自定义 Query 类:

php artisan lighthouse:query UsersQuery

然后在 schema 中引用:

users: [User!]! @field(resolver: "UsersQuery@resolve")

测试 GraphQL API

启动开发服务器:

php artisan serve

访问 http://localhost:8000/graphql,推荐使用 GraphiQLAltair 工具测试。

发送示例查询:

{
  users {
    id
    name
    email
  }
}

应返回用户列表数据。

启用分页、认证和更多功能

Lighthouse 支持分页:

type Query {
  users: [User!]! @paginate(type: "relay", model: "App\\Models\\User")
}

结合 Laravel Sanctum 实现认证:

type Query {
  me: User @auth
}

在请求头中携带 Bearer Token 即可验证。

基本上就这些。Lighthouse 让 Laravel 快速拥有规范的 GraphQL 接口,适合中小型项目快速开发。合理利用指令能大幅减少代码量。集成过程不复杂但容易忽略路由加载或模型命名空间问题,注意检查配置即可。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

320

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

278

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

373

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

374

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

85

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

65

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

68

2025.08.05

composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

Golang 网络安全与加密实战
Golang 网络安全与加密实战

本专题系统讲解 Golang 在网络安全与加密技术中的应用,包括对称加密与非对称加密(AES、RSA)、哈希与数字签名、JWT身份认证、SSL/TLS 安全通信、常见网络攻击防范(如SQL注入、XSS、CSRF)及其防护措施。通过实战案例,帮助学习者掌握 如何使用 Go 语言保障网络通信的安全性,保护用户数据与隐私。

0

2026.01.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 10万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号