PHP Academy · Pelajaran

Membina Klien API Ringkas

Bungkus panggilan cURL dalam kelas klien API PHP yang boleh diguna semula.

Pelajaran 4 daripada 413 langkah

Membina Klien API Ringkas ialah pelajaran PHP Academy percuma di CoddyKit. Ini ialah pelajaran 4 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran PHP Academy, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus PHP Academy merangkumi sejumlah 4 pelajaran.

Mengapa Membungkus cURL?

Kelas klien API khusus memusatkan pengesahan, URL asas, pengendalian ralat dan pencatatan — sekali gus mengelakkan kod berulang di seluruh pangkalan kod.

Rangka Kelas Klien

Klien API minimum dengan URL asas dan token pengesahan.

<?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);
    }
}

Kaedah GET dan POST

Sediakan kaedah kemudahan yang menyerahkan tugas kepada kaedah peribadi request().

<?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);
}

Menggunakan Klien

Cipta tika dan panggil kaedah berjenis dan bukannya menggunakan cURL mentah.

<?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"]);

Parameter Rentetan Pertanyaan

Bina rentetan pertanyaan dengan 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]);

Pembantu Penomboran Halaman

Tambah pembantu untuk mengumpulkan semua halaman API yang berhalaman secara automatik.

<?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;
}

Menyimpan Respons dalam Cache

Masukkan lapisan cache untuk mengelakkan permintaan yang berulang.

<?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;
}

Pencatatan

Tambah pencatat PSR-3 untuk merekodkan setiap permintaan dan respons bagi tujuan penyahpepijatan.

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

Menguji Klien

Dalam ujian unit, gantikan cURL dengan pengendali HTTP olok-olok (contohnya Guzzle MockHandler) supaya ujian berjalan tanpa panggilan rangkaian sebenar.

Guzzle sebagai Alternatif

Untuk kegunaan produksi, pertimbangkan Guzzle (composer require guzzlehttp/guzzle), yang menyediakan perantara, permintaan tak segerak dan API yang matang.

Pilihan HTTP_FOUNDATION

Symfony HttpClient (symfony/http-client) ialah satu lagi alternatif yang cemerlang dengan antara muka yang kemas dan sokongan tak segerak terbina dalam.

Ringkasan

Membungkus cURL dalam kelas mengurangkan penduaan, memusatkan pengendalian ralat dan memudahkan ujian. Sediakan kaedah berjenis (get, post) berbanding kata kerja HTTP mentah.

Semakan Pantas

Fungsi PHP manakah yang membina rentetan pertanyaan URL?

Percuma untuk bermula

Pelajari PHP dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus
49
Pelajaran
195

Soalan Lazim

Adakah pelajaran “Membina Klien API Ringkas” percuma?

Ya — teks penuh “Membina Klien API Ringkas” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus PHP Academy, tingkat taraf kepada CoddyKit PRO. Kursus PHP Academy merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “Membina Klien API Ringkas”?

Bungkus panggilan cURL dalam kelas klien API PHP yang boleh diguna semula. Anda berlatih PHP Academy menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan PHP Academy?

Tiada pengalaman terdahulu diperlukan. Pembelajaran PHP Academy di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 4 daripada 4.

Berapa lamakah pelajaran “Membina Klien API Ringkas” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran PHP Academy ini?

Ya. Setiap pelajaran PHP Academy menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

  1. Pengekodan dan Penyahkodan JSON
  2. Membuat Permintaan HTTP dengan cURL
  3. Mengendalikan Respons dan Ralat API
  4. Membina Klien API Ringkas
← Kembali ke PHP Academy