在 Laravel 應用中構建 GraphQL API

Summer__發表於2019-01-16
LaravelAPI

file

程式碼示例：產品列表和使用者列表的 API 例子

昨天我們學習了 在 Visual Code 中搭建 Laravel 環境，現在我們來學習 Facebook 的 GraphQL 。

GraphQL 是一種 API 查詢語言，還是一種根據你為資料定義的型別系統執行查詢的伺服器端執行時。GraphQL 不依賴於任何指定的資料庫或儲存引擎，而是由你的程式碼和資料來作支援的。 graphql.org

GraphQL 可以提升 API 呼叫的靈活性，我們可以像寫資料庫查詢語句一樣來請求 API 來獲取所需要的資料，這對構建複雜的 API 查詢來說非常有用。GraphQL 還提供了視覺化介面來幫助我們編寫查詢語句，還提供了自動補全的功能，這讓編寫查詢更加簡單。

github.com/graphql/gra…

從以下圖片可以看出，GraphQL 和 Rest 一樣都是執行在業務邏輯層以外的：

file

# 開始

1. 安裝 Laravel

使用下面命令安裝最新版本的 Laravel ：

# 在命令列中執行
composer global require "laravel/installer"
laravel new laravel-graphql
複製程式碼

2. 新增 GraphQL 的包

使用 composer 安裝 graphql-laravel，這個包提供了非常多的功能用於整合 Laravel 和 GraphQL 。

3. 建立模型

像下面這樣建立模型和表 user_profiles, products, product_images，別忘了還要建立模型間的關係。

file

4. 建立查詢和定義 GraphQL 的型別

GraphQL 中的查詢與 Restful API 中的末端路徑查詢是一樣的，查詢只是用於獲取資料，以及建立、更新、刪除操作。我們把它稱作 Mutation 。

GraphQL 中的 型別 用於定義查詢中每個欄位的型別定義，型別會幫助我們格式化查詢結果中的有格式的欄位，例如布林型別，字串型別，浮點型別，整數型別等等，以及我們的自定義型別。下面是查詢和型別的目錄結構：

file

這是 UsersQuery.php 和 UsersType.php 檔案完整的原始碼：

<?php
namespace App\GraphQL\Query;
use App\User;
use GraphQL\Type\Definition\Type;
use Rebing\GraphQL\Support\Facades\GraphQL;
use Rebing\GraphQL\Support\Query;
use Rebing\GraphQL\Support\SelectFields;
class UsersQuery extends Query
{
    protected $attributes = [
        'name' => 'Users Query',
        'description' => 'A query of users'
    ];
    public function type()
    {
        // 帶分頁效果的查詢結果
        return GraphQL::paginate('users');
    }
    
    // 過濾查詢的引數
    public function args()
    {
        return [
            'id' => [
                'name' => 'id',
                'type' => Type::int()
            ],
            'email' => [
                'name' => 'email',
                'type' => Type::string()
            ]
        ];
    }
    public function resolve($root, $args, SelectFields $fields)
    {
        $where = function ($query) use ($args) {
            if (isset($args['id'])) {
                $query->where('id',$args['id']);
            }
            if (isset($args['email'])) {
                $query->where('email',$args['email']);
            }
        };
        $user = User::with(array_keys($fields->getRelations()))
            ->where($where)
            ->select($fields->getSelect())
            ->paginate();
        return $user;
    }
}
複製程式碼
<?php
namespace App\GraphQL\Type;
use App\User;
use GraphQL\Type\Definition\Type;
use Rebing\GraphQL\Support\Facades\GraphQL;
use Rebing\GraphQL\Support\Type as GraphQLType;
class UsersType extends GraphQLType
{
    protected $attributes = [
        'name' => 'Users',
        'description' => 'A type',
        'model' => User::class, // 定義使用者型別的資料模型
    ];
    
    // 定義欄位的型別
    public function fields()
    {
        return [
            'id' => [
                'type' => Type::nonNull(Type::int()),
                'description' => 'The id of the user'
            ],
            'email' => [
                'type' => Type::string(),
                'description' => 'The email of user'
            ],
            'name' => [
                'type' => Type::string(),
                'description' => 'The name of the user'
            ],
            // 資料模型 user_profiles 中的關聯欄位
            'user_profiles' => [
                'type' => GraphQL::type('user_profiles'),
                'description' => 'The profile of the user'
            ]
        ];
    }
    protected function resolveEmailField($root, $args)
    {
        return strtolower($root->email);
    }
}
複製程式碼

在編寫完查詢語句和型別之後，我們需要編輯 config/graphql.php 檔案，將查詢語句和型別註冊到 Schema 中。

<?php
use App\GraphQL\Query\ProductsQuery;
use App\GraphQL\Query\UsersQuery;
use App\GraphQL\Type\ProductImagesType;
use App\GraphQL\Type\ProductsType;
use App\GraphQL\Type\UserProfilesType;
use App\GraphQL\Type\UsersType;
return [
    'prefix' => 'graphql',
    'routes' => 'query/{graphql_schema?}',
    'controllers' => \Rebing\GraphQL\GraphQLController::class . '@query',
    'middleware' => [],
    'default_schema' => 'default',
    // 註冊查詢命令 
    'schemas' => [
        'default' => [
            'query' => [
                'users' => UsersQuery::class,
                'products' => ProductsQuery::class,
            ],
            'mutation' => [
            ],
            'middleware' => []
        ],
    ],
    // 註冊型別
    'types' => [
        'product_images' => ProductImagesType::class,
        'products'  => ProductsType::class,
        'user_profiles'  => UserProfilesType::class,
        'users'  => UsersType::class,
    ],
    'error_formatter' => ['\Rebing\GraphQL\GraphQL', 'formatError'],
    'params_key'    => 'params'
];
複製程式碼

5. Testing

我們可以使用 GraphiQL 來十分簡單地編寫查詢語句，因為在編寫的時候它可以自動補全，或者我們也可以使用 postman 來請求 API，下面是自動補全的示例：

file

下面是查詢結果的示例

file

如果你想查閱原始碼，可以訪問以下地址 :)。

github.com/ardani/lara…

轉自 PHP / Laravel 開發者社群 laravel-china.org/topics/2206…

相關文章