So erstellen Sie eine API-Schnittstelle mit GraphQL in PHP

GraphQL ist eine neue API-Abfragesprache, die die Daten, die auf dem Client zurückgegeben werden müssen, genau angeben kann, wodurch die Übertragung unnötiger Daten durch den Server reduziert und die Effizienz von Netzwerkanforderungen und Datenübertragung verbessert wird. Im Vergleich zur herkömmlichen API im RESTful-Stil ist GraphQL flexibler und effizienter. In diesem Artikel untersuchen wir, wie man GraphQL in PHP zum Erstellen von API-Schnittstellen verwendet.

1. GraphQL-Bibliothek installieren

Bevor Sie GraphQL verwenden, müssen Sie GraphQL-bezogene Bibliotheken installieren. In PHP ist webonyx/graphql-php die beliebteste GraphQL-Bibliothek. Wir können es über Composer installieren. Die spezifischen Vorgänge sind wie folgt:

$ composer require webonyx/graphql-php

2. Schema erstellen

In GraphQL definiert das Schema das Datenmodell und die Abfrageanweisungen. Schema ist der Kernbestandteil von GraphQL. Durch die Definition eines Schemas können wir das Verhalten und die Datenform der API definieren. GraphQL-php verwendet die Klasse GraphQLTypeSchema, um das Schema zu erstellen. Hier ist zum Beispiel eine einfache Schemadefinition:

use GraphQLTypeDefinitionType;
use GraphQLTypeSchema;

$queryType = new GraphQLTypeDefinitionObjectType([
    'name' => 'Query',
    'fields' => [
        'message' => [
            'type' => Type::string(),
            'resolve' => function() {
                return 'Hello, World!';
            }
        ],
    ]
]);

$schema = new Schema([
    'query' => $queryType
]);

In diesem Beispiel definieren wir einen Abfragetyp, der ein Feld enthält. Das Feld heißt „Nachricht“ und gibt eine Zeichenfolge „Hello, World!“ zurück. Im Schema definieren und exportieren wir den queryType und verwenden diesen Typ, um den Abfrageeintrag des Schemas anzugeben.

3. Verarbeitung von GraphQL-Anfragen

Sobald das Schema definiert ist, können Sie mit der Verarbeitung von GraphQL-Anfragen beginnen. Wir können die PHP-Bibliothek von GraphQL verwenden, um Anfragen zu bearbeiten. Darunter stellt die GraphQLServerStandardServer-Klasse die Implementierung des Servers bereit und leitet die Anforderung an den Schema-Handler weiter, um das Antwortergebnis zu erhalten. Die grundlegenden Schritte zur Bearbeitung einer GraphQL-Anfrage sind wie folgt:

• Abrufen der Anforderungsparameter
• Analysieren der Anforderungsparameter in eine GraphQL-Abfrage
• Ausführen der Anforderung
• Zurückgeben des Ergebnisses

Hier ist ein grundlegender Beispielcode für die Verarbeitung eine GraphQL-Anfrage:

use GraphQLServerStandardServer;

// 获取请求参数
$request = json_decode(file_get_contents('php://input'), true);

// 将请求参数解析为GraphQL查询
$query = isset($request['query']) ? $request['query'] : null;
$variables = isset($request['variables']) ? $request['variables'] : null;

// 执行请求
$server = new StandardServer([
    'schema' => $schema,
    'debug' => true,
]);
$result = $server->executePsrRequest(Request::fromGlobals(), $query, [], $variables);

// 返回结果
echo json_encode($result);

In diesem Beispiel erhalten wir zunächst die Anfrageparameter. Die Anforderungsparameter werden dann in eine GraphQL-Abfrage geparst und über StandardServer ausgeführt. Schließlich serialisieren wir das Rückgabeergebnis in das JSON-Format und geben es an den Client zurück.

4. Funktionen, Berechtigungen und Authentifizierung

Um die Funktionalität der GraphQL-API zu erhöhen, können wir „Funktionen“ und „Berechtigungen“ hinzufügen. Die Unterstützung dieser Funktionen durch GraphQL ist recht leistungsstark. Sie können beispielsweise die „erzwungene Typprüfung“ von GraphQL verwenden, um sicherzustellen, dass jedes Feld den richtigen Datentyp hat. Darüber hinaus können Sie die „Schemavalidierung“ von GraphQL verwenden, um sicherzustellen, dass jedes Feld vorhanden ist und dem von uns definierten Typ entspricht.

Gleichzeitig müssen wir zum Schutz der Datensicherheit möglicherweise „Berechtigungen“ zur API hinzufügen. „Berechtigung“ dient der Überprüfung, ob der Benutzer über die Berechtigung zum Zugriff auf bestimmte Daten in der Datenbank verfügt. GraphQL bietet verschiedene Möglichkeiten zur Implementierung von Berechtigungskontrollanforderungen. Bei der Definition des Schemas können Sie beispielsweise eine leistungsstarke rollenbasierte Zugriffskontrolle definieren.

Authentifizierung ist ein Teil der Webanwendungsauthentifizierung und wird verwendet, um die Identität des Benutzers zu erkennen. Die Authentifizierung wird auch in GraphQL unterstützt. Bei der Bearbeitung von Anfragen können wir die Sicherheit der API gewährleisten, indem wir prüfen, ob der Benutzer über eine gültige Authentifizierungsmethode verfügt. Bei der Implementierung der Authentifizierung können wir auch die Identitätsinformationen des Benutzers als Parameter in jede Anfrage übergeben.

5. Kontexte verwenden

GraphQL führt das Konzept des „Kontexts“ ein, um das Problem des temporären Zustands oder der Eigenschaften zu lösen, die beim Zugriff auf oder bei der Aktualisierung von Daten erforderlich sind. Ein Kontext ist typischerweise ein persistenter Speicher oder Cache, der mit einer GraphQL-Operation verbunden ist, kann aber auch beliebige nützliche Informationen enthalten, wie etwa Authentifizierungsdaten für den aktuellen Benutzer und etwaige Anforderungsdaten.

In PHP können wir Daten an jede Anfrage übergeben, indem wir Parameter im Kontext hinzufügen. Hier ist zum Beispiel ein einfaches Beispiel:

$context = [
    'db' => $db,
    'currentUser' => $currentUser,
];

$server = new StandardServer([
    'schema' => $schema,
    'context' => $context,
]);

$result = $server->processPsrRequest($request, $response);

In diesem Beispiel definieren wir eine Variable namens „context“ und fügen die Variable dem Request-Handler hinzu. Auf diese Weise kann jede Anfrage auf diesen Kontext zugreifen und die darin enthaltenen Informationen nutzen.

Zusammenfassung

Um eine API-Schnittstelle mit GraphQL in PHP zu erstellen, müssen wir die GraphQL-Bibliothek installieren, das Schema definieren, GraphQL-Anfragen verarbeiten, Berechtigungen und Authentifizierung implementieren und den Kontext zur Weitergabe von Informationen verwenden. Der wahre Wert von GraphQL besteht darin, dass es eine flexible und effiziente Möglichkeit zum Abfragen und Bearbeiten von Daten bietet und Entwicklern dabei hilft, elegantere und effizientere APIs zu erstellen. Ich hoffe, dieser Artikel kann den Lesern helfen, GraphQL besser zu verstehen, zu lernen und es zum Erstellen erstaunlicher APIs in PHP zu verwenden.

Das obige ist der detaillierte Inhalt vonSo erstellen Sie eine API-Schnittstelle mit GraphQL in PHP. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!