學習如何使用PHP建立GraphQL API：建構API介面的步驟

GraphQL是一個用於API的查詢語言，它可以讓客戶端精確地查詢數據，避免浪費網路頻寬和伺服器資源。在本文中，我們將討論如何使用PHP建立GraphQL API。

GraphQL API的工作原理

GraphQL API是基於查詢語言的。客戶端發送查詢請求到伺服器，伺服器解析請求並傳回對應資料。請求和回應都是以GraphQL語言格式發送和接收的。

GraphQL API也支援多層關聯查詢，客戶端可以查詢一些數據，然後在同一個查詢中請求相關數據。這大大減少了網路頻寬和伺服器開銷。

GraphQL API中有三個主要的概念：查詢、型別和解析器。查詢是客戶端發送的請求，GraphQL類型是API中使用的對象，解析器是將請求轉換為回應的程式碼。

建立GraphQL API

我們將使用PHP實作GraphQL API，並使用webonyx/graphql-php函式庫來建構和解析查詢。

首先，我們需要建立一些GraphQL類型，這些類型描述了API中的物件。以下是一個範例User類型：

use GraphQLTypeDefinitionType;
use GraphQLTypeDefinitionObjectType;

$userType = new ObjectType([
    'name' => 'User',
    'fields' => [
        'id' => Type::int(),
        'name' => Type::string(),
        'email' => Type::string()
    ]
]);

上面的程式碼建立了一個名為User的類型，包含三個欄位：id、name和email。每個欄位都有一個類型，Type::int()表示整數類型，Type::string()表示字串類型。

接下來，我們需要建立一個解析器來處理查詢。以下是一個範例使用者查詢解析器：

$rootValue = [
    'users' => [
        ['id' => 1, 'name' => 'Alice', 'email' => 'alice@example.com'],
        ['id' => 2, 'name' => 'Bob', 'email' => 'bob@example.com']
    ]
];

$resolver = function ($root, $args) {
    global $rootValue;

    if (isset($args['id'])) {
        foreach ($rootValue['users'] as $user) {
            if ($user['id'] == $args['id']) {
                return $user;
            }
        }
    } else {
        return $rootValue['users'];
    }
};

上面的程式碼建立了一個$rootValue數組，它包含了兩個使用者物件。 $resolver函數會根據客戶端發送的請求來傳回對應的資料。如果請求帶有id參數，將傳回具有該id的使用者訊息，否則將傳回所有使用者資訊。

最後，我們需要將上述型別和解析器綁定到GraphQL API中。以下是綁定程式碼：

use GraphQLGraphQL;
use GraphQLTypeSchema;

$schema = new Schema([
    'query' => new ObjectType([
        'name' => 'Query',
        'fields' => [
            'user' => [
                'type' => $userType,
                'args' => ['id' => Type::int()],
                'resolve' => $resolver
            ],
            'users' => [
                'type' => Type::listOf($userType),
                'resolve' => $resolver
            ]
        ]
    ])
]);

if (!empty($_POST['query'])) {
    $result = GraphQL::executeQuery($schema, $_POST['query']);
    echo json_encode($result->toArray());
}

上面的程式碼將使用者類型和解析器綁定到GraphQL API中，並建立​​了一個查詢物件。在查詢物件中，我們可以定義多個查詢，例如'user'和'users'。每個查詢都需要指定其類型和解析器，解析器在偵測到查詢時將被呼叫。

然後，我們需要透過POST請求將查詢傳送到API中，並解析回應資料。以上述程式碼為例，我們會從API中取得回應JSON物件並直接輸出。

總結

在本文中，我們介紹如何使用PHP建立GraphQL API。我們討論了GraphQL API的工作原理，並提供了一些範例程式碼來示範如何建立類型、解析器並將其綁定到API中。我們也使用webonyx/graphql-php函式庫來簡化API的建置和解析。如果您想了解更多關於GraphQL的信息，請參考GraphQL官方文件。

以上是學習如何使用PHP建立GraphQL API：建構API介面的步驟的詳細內容。更多資訊請關注PHP中文網其他相關文章！