cebugle/laravel-graphql-playground
Composer 安装命令：
composer require cebugle/laravel-graphql-playground
包简介
Easily integrate GraphQL Playground into your Laravel project
README 文档
README
Deprecated
This project is deprecated in favor of https://github.com/mll-lab/laravel-graphiql.
Easily integrate GraphQL Playground into your Laravel projects.
Please note: This is not a GraphQL Server implementation, only a UI for testing and exploring your schema. For the server component we recommend nuwave/lighthouse.
Installation
composer require cebugle/laravel-graphql-playground
If you are using Lumen, register the service provider in bootstrap/app.php
$app->register(Cebugle\GraphQLPlayground\GraphQLPlaygroundServiceProvider::class);
Configuration
By default, the playground is reachable at /graphql-playground
and assumes a running GraphQL endpoint at /graphql.
To change the defaults, publish the configuration with the following command:
php artisan vendor:publish --tag=graphql-playground-config
You will find the configuration file at config/graphql-playground.php.
Lumen
If you are using Lumen, copy it into that location manually and load the configuration
in your boostrap/app.php:
$app->configure('graphql-playground');
HTTPS behind proxy
If your application sits behind a proxy which resolves https, the generated URL for the endpoint
might not use https://, thus causing the Playground to not work by default. In order to solve
this, configure your TrustProxies middleware to contain \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR
in $headers.
Customization
To customize the Playground even further, publish the view:
php artisan vendor:publish --tag=graphql-playground-view
You can use that for all kinds of customization.
Change settings of the playground instance
Add extra settings in the call to GraphQLPlayground.init in the published view:
GraphQLPlayground.init(document.getElementById('root'), { endpoint: "{{ url(config('graphql-playground.endpoint')) }}", subscriptionEndpoint: "{{ config('graphql-playground.subscriptionEndpoint') }}", // See https://github.com/graphql/graphql-playground#properties for available settings })
Configure session authentication
Session based authentication can be used with Laravel Sanctum.
If you use GraphQL through sessions and CSRF, add the following to the <head> in the published view:
<meta name="csrf-token" content="{{ csrf_token() }}">
Modify the Playground config:
GraphQLPlayground.init(document.getElementById('root'), {
endpoint: "{{ url(config('graphql-playground.endpoint')) }}",
subscriptionEndpoint: "{{ config('graphql-playground.subscriptionEndpoint') }}",
+ settings: {
+ 'request.credentials': 'same-origin',
+ 'request.globalHeaders': {
+ 'X-CSRF-TOKEN': document.querySelector('meta[name="csrf-token"]').content
+ }
+ }
})
Make sure your route includes the web middleware group in config/graphql-playground.php:
'route' => [
'uri' => '/graphql-playground',
'name' => 'graphql-playground',
+ 'middleware' => ['web']
]
Local assets
If you want to serve the assets from your own server, you can download them with the command
php artisan graphql-playground:download-assets
This puts the necessary CSS, JS and Favicon into your public directory. If you have
the assets downloaded, they will be used instead of the online version from the CDN.
Security
If you do not want to enable the GraphQL playground in production, you can disable it in the config file.
The easiest way is to set the environment variable GRAPHQL_PLAYGROUND_ENABLED=false.
If you want to protect the route to the GraphQL playground, you can add custom middleware in the config file.
cebugle/laravel-graphql-playground 适用场景与选型建议
cebugle/laravel-graphql-playground 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 16 次下载、GitHub Stars 达 0， 最近一次更新时间为 2023 年 02 月 19 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「laravel」 「graphql」 「graphql-playground」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 cebugle/laravel-graphql-playground 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 cebugle/laravel-graphql-playground 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 cebugle/laravel-graphql-playground 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Easily integrate GraphQL Playground into your Laravel project
GraphQL authentication for your headless Craft CMS applications.
Authorize introspection documentarion for rebing/graphql-laravel
Sylius backend integration for Vue Storefront 2
GraphQL client and query builder.
A basic Shopify API wrapper with REST and GraphQL support.
统计信息
- 总下载量： 16
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 0
- 点击次数： 9
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2023-02-19