Lighthouse 开源项目指南

Lighthouse 开源项目指南

lighthouseA framework for serving GraphQL from Laravel项目地址:https://gitcode.com/gh_mirrors/li/lighthouse

1. 项目目录结构及介绍

在 Lighthouse 的项目中，目录结构通常如下：

.
├── composer.json           # PHP 依赖管理文件
├── config                  # 配置文件夹
│   ├── lighthouse.php       # Lighthouse 主配置文件
├── database                # 数据库迁移和种子文件
├── public                  # 公共可访问资源
│   └── index.php            # 项目入口文件
├── src                     # 自定义代码存放处
│   └── GraphQL              # 自定义 GraphQL 类和类型
└── tests                   # 测试文件夹

• composer.json: 用来管理 PHP 库和扩展的依赖。
• config/lighthouse.php: 存放 Lighthouse 的核心配置选项，用于自定义行为和服务。
• database: 包含 Laravel 的数据库迁移和填充数据的种子文件。
• public/index.php: 项目的前端入口文件，处理 HTTP 请求。
• src: 用户可以在这里添加自己的 GraphQL 操作、类型和其他代码。
• tests: 测试文件夹，存放自动化测试。

2. 项目的启动文件介绍

Lighthouse 项目中的主要入口点是 public/index.php 文件。当请求到达时，该文件初始化 Laravel 框架并传递请求给 Laravel-Lighthouse。通常，你不需要直接修改此文件，除非你需要自定义框架的启动逻辑。

<?php

// ...
require __DIR__.'/../vendor/autoload.php';

use Illuminate\Contracts\Http\Kernel;
use Illuminate\Foundation\Http\Bootstrap\RegisterProviders;

$app = require_once __DIR__.'/../bootstrap/app.php';

// ...
$kernel = $app->make(Kernel::class);

$response = $kernel->handle(
    $request = Illuminate\Http\Request::capture()
);

$response->send();

$kernel->terminate($request, $response);

这里的 bootstrap/app.php 文件是 Laravel 框架的启动配置，它加载服务提供者和应用程序实例化。

3. 项目的配置文件介绍

Lighthouse 的配置位于 config/lighthouse.php 文件，它允许你定制许多方面，如认证、错误处理、中间件和图形QL字段的行为。以下是一些关键配置示例：

return [
    'debug' => env('APP_DEBUG', false), // 是否开启调试模式
    'auth' => [ // 认证相关的配置
        'default' => env('AUTH_DEFAULT_GUARD', null),
        'strategies' => [], // 认证策略
    ],
    'directives' => [ // 定义自定义指令
        // ...
    ],
    'graphql' => [ // 图形QL引擎配置
        'playground' => env('GRAPHQL_PLAYGROUND_ENABLED', true), // 是否启用图形化界面
        'debug' => env('GRAPHQL_DEBUG', env('APP_DEBUG', false)), // 是否显示调试信息
    ],
];

你可以通过修改这些值来调整 Lighthouse 的行为以满足你的应用需求。此外，记得在配置文件中更改后更新 .env 文件以保持一致的环境变量设置。

本文档简要介绍了 Lighthouse 的基本目录结构、启动文件及其配置文件。对于更详细的使用和开发指南，建议参考官方文档或项目仓库中的 README 文件。

lighthouseA framework for serving GraphQL from Laravel项目地址:https://gitcode.com/gh_mirrors/li/lighthouse