https://github.com/johnlui/graphql-laravel

A Laravel GraphQL reference implementation forked from webonyx/graphql-php
https://github.com/johnlui/graphql-laravel

graphql laravel php

Last synced: 4 days ago
JSON representation

A Laravel GraphQL reference implementation forked from webonyx/graphql-php

• Host: GitHub
• URL: https://github.com/johnlui/graphql-laravel
• Owner: johnlui
• License: mit
• Created: 2020-11-15T03:49:13.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-11T15:17:50.000Z (over 1 year ago)
• Last Synced: 2024-04-15T10:02:51.350Z (7 months ago)
• Topics: graphql, laravel, php
• Language: PHP
• Homepage:
• Size: 604 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





  

  

  

  

  






[`webonyx/graphql-php`](https://github.com/webonyx/graphql-php) 的 Laravel 适配，魔改原库，将其彻底融入 Laravel 生命周期。

## 功能

1. 接入 Laravel Middleware

2. 依赖 Laravel Exception 处理异常流程

3. 完美接入 Eloquent

4. 提炼出 GraphQL 路由

5. 提供 Types 文件夹，并提供强大的 Type 基类

6. 提供 QueryFields 文件夹，提供类似于 Controller 归类的功能

7. 暴露用户请求字段给 QueryField，便于节约资源、并发 RPC 等后续操作

8. 提供 JSON API 语境下的调试函数 `cc()`




## 用法

### 安装 Composer 包

`composer require johnlui/graphql-laravel`

### 部署开发目录及配置文件到 app 下

`php artisan vendor:publish`

### 快速入门

> 1. `app\GraphApp` 为工作文件夹

> 2. `Routes.php` 为路由文件

> 3. `QueryFields` 目录存放响应代码

> 4. `Types` 目录存放自定义类型

> 5. `config/graphql.php` 为配置文件

## demo

#### query：

```graphql

query ($id: Int) {

  foo(id: $id) {

    id

    foo

    bar

  }

}

```

#### variables:

此处为 JSON 格式描述，开发时应使用 key-value 形式描述 variables，不应该使用 JSON 字符串。

```json

{

  "id": 200

}

```

#### 启动 server

`php artisan serve`

#### url

`http://127.0.0.1:8000/graphql`

修改默认路径请编辑`config/graphql.php`中的`apiUri`。

#### curl raw 代码描述

```bash

curl --location --request POST 'http://127.0.0.1:8000/graphql' \

--header 'Content-Type: application/json' \

--data-raw '{"query":"query($id: Int) {\n    foo(id: $id) {\n        id\n        foo\n        bar\n    }\n}","variables":{"id":200}}'

```

#### 返回值

```json

{

  "status": 0,

  "message": "OK",

  "values": {

    "foo": {

      "id": 200,

      "foo": "foo",

      "bar": "bar"

    },

    "queries": []

  }

}

```

## License

The `johnlui/GraphQL-Laravel` is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)