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

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 就能映射。

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

集简云

软件集成平台,快速建立企业自动化与智能化

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

查看详情 laravel怎么集成Lighthouse包实现GraphQL API_laravel Lighthouse GraphQL API集成方法

如果需要自定义逻辑,可以创建自定义 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: "appModelsUser") } 

结合 Laravel Sanctum 实现认证:

 type Query {   me: User @auth } </font> 

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

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

以上就是laravel怎么集成Lighthouse包实现GraphQL API_laravel Lighthouse GraphQL API集成方法的详细内容,更多请关注php中文网其它相关文章!

上一篇
下一篇
text=ZqhQzanResources