PHP Academy · Lektion

Einen einfachen API-Client erstellen

Kapseln Sie cURL-Aufrufe in einer wiederverwendbaren PHP-API-Client-Klasse.

Einen einfachen API-Client erstellen ist eine kostenlose PHP Academy-Lektion auf CoddyKit. Dies ist Lektion 4 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des PHP Academy-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der PHP Academy-Kurs umfasst insgesamt 4 Lektionen.

Warum cURL kapseln?

Eine eigene API-Client-Klasse zentralisiert Authentifizierung, Basis-URL, Fehlerbehandlung und Protokollierung und vermeidet dadurch wiederholten Boilerplate-Code in der gesamten Codebasis.

Grundgerüst der Client-Klasse

Ein minimaler API-Client mit einer Basis-URL und einem Authentifizierungs-Token.

<?php
class ApiClient {
    public function __construct(
        private string $baseUrl,
        private string $token
    ) {}

    private function request(string $method, string $path, array $data = []): array {
        $ch = curl_init($this->baseUrl.$path);
        curl_setopt_array($ch, [
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_CUSTOMREQUEST  => $method,
            CURLOPT_HTTPHEADER     => [
                "Authorization: Bearer ".$this->token,
                "Content-Type: application/json",
                "Accept: application/json",
            ],
        ]);
        if (!empty($data)) {
            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
        }
        $body   = curl_exec($ch);
        $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        if ($status >= 400) throw new RuntimeException("API error $status: $body");
        return json_decode($body, true, 512, JSON_THROW_ON_ERROR);
    }
}

GET- und POST-Methoden

Stellen Sie komfortable Methoden bereit, die an die private Methode request() delegieren.

<?php
public function get(string $path): array {
    return $this->request("GET", $path);
}

public function post(string $path, array $body): array {
    return $this->request("POST", $path, $body);
}

Den Client verwenden

Instanziieren Sie den Client und rufen Sie typisierte Methoden statt rohem cURL auf.

<?php
$client = new ApiClient("https://api.example.com", $apiToken);
$users  = $client->get("/v1/users");
$user   = $client->post("/v1/users", ["name" => "Alice", "email" => "alice@example.com"]);

Query-String-Parameter

Erstellen Sie Query-Strings mit http_build_query().

<?php
public function get(string $path, array $params = []): array {
    $qs = $params ? "?".http_build_query($params) : "";
    return $this->request("GET", $path.$qs);
}
// Usage:
$users = $client->get("/v1/users", ["page" => 1, "limit" => 20]);

Hilfsfunktion für die Seitennavigation

Fügen Sie eine Hilfsfunktion hinzu, die automatisch alle Seiten einer paginierten API abruft.

<?php
public function paginate(string $path): array {
    $all  = [];
    $page = 1;
    do {
        $res  = $this->get($path, ["page" => $page++]);
        $all  = array_merge($all, $res["data"]);
    } while ($res["has_more"] ?? false);
    return $all;
}

Antworten zwischenspeichern

Injizieren Sie eine Cache-Schicht, um redundante Anfragen zu vermeiden.

<?php
public function getCached(string $path, int $ttl = 60): array {
    $key = "api:".md5($path);
    if (apcu_exists($key)) return apcu_fetch($key);
    $data = $this->get($path);
    apcu_store($key, $data, $ttl);
    return $data;
}

Protokollierung

Fügen Sie einen PSR-3-Logger hinzu, um jede Anfrage und Antwort zu Debugging-Zwecken zu protokollieren.

<?php
public function __construct(
    private string $baseUrl,
    private string $token,
    private ?\Psr\Log\LoggerInterface $logger = null
) {}

Den Client testen

Ersetzen Sie cURL in Unit-Tests durch einen simulierten HTTP-Handler, beispielsweise Guzzle MockHandler, damit die Tests ohne echte Netzwerkaufrufe ausgeführt werden können.

Guzzle als Alternative

Erwägen Sie für den Produktionseinsatz Guzzle (composer require guzzlehttp/guzzle), das Middleware, asynchrone Anfragen und eine ausgereifte API bereitstellt.

HTTP_FOUNDATION-Option

Symfony HttpClient (symfony/http-client) ist eine weitere hervorragende Alternative mit einer übersichtlichen Schnittstelle und erstklassiger Unterstützung für asynchrone Aufrufe.

Zusammenfassung

Das Kapseln von cURL in einer Klasse reduziert Duplikate, zentralisiert die Fehlerbehandlung und erleichtert das Testen. Stellen Sie typisierte Methoden (get, post) anstelle roher HTTP-Verben bereit.

Kurze Überprüfung

Welche PHP-Funktion erstellt URL-Query-Strings?

Häufig gestellte Fragen

Ist die Lektion „Einen einfachen API-Client erstellen“ kostenlos?

Ja — der vollständige Text von „Einen einfachen API-Client erstellen“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des PHP Academy-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der PHP Academy-Kurs umfasst insgesamt 4 Lektionen.

Was lerne ich in „Einen einfachen API-Client erstellen“?

Kapseln Sie cURL-Aufrufe in einer wiederverwendbaren PHP-API-Client-Klasse. Du übst PHP Academy mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um PHP Academy zu starten?

Keine Vorkenntnisse erforderlich. PHP Academy auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 4 von 4.

Wie lange dauert die Lektion „Einen einfachen API-Client erstellen“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser PHP Academy-Lektion Code schreiben und ausführen?

Ja. Jede PHP Academy-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

← Zurück zu PHP Academy