Kaedah dan pelaksanaan memanggil antara muka API dalam PHP

Dengan kemunculan Internet, pengkomputeran awan dan era data besar, semakin banyak aplikasi perlu memanggil antara muka API pihak ketiga untuk mendapatkan data dan mencapai kesaling kendalian data dan kerja kolaboratif. Sebagai bahasa sebelah pelayan yang biasa digunakan, PHP juga boleh merealisasikan interaksi data dan penyepaduan sistem yang berbeza dengan memanggil antara muka API. Artikel ini akan memperkenalkan kaedah dan proses pelaksanaan memanggil antara muka API dalam PHP.

1. Pengenalan kepada antara muka API

API (Antara Muka Pengaturcaraan Aplikasi) ialah protokol yang digunakan untuk komunikasi antara aplikasi yang berbeza. Ringkasnya, API ialah satu set konvensyen boleh atur cara yang menentukan cara aplikasi berkomunikasi dengan program atau pelayan lain. Melalui API, aplikasi boleh meminta perkhidmatan atau data daripada aplikasi lain, atau menyediakan perkhidmatan atau datanya sendiri kepada aplikasi lain.

API biasanya menggunakan protokol standard seperti HTTP atau SOAP untuk komunikasi dan menyokong pertukaran berbilang format data, seperti XML, JSON, CSV, dsb. API selalunya memerlukan pengesahan dan lulus parameter untuk memastikan kesahihan dan keselamatan data.

2. Cara memanggil antara muka API dengan PHP

1 Gunakan perpustakaan curl untuk membuat permintaan HTTP

curl ialah alat penghantaran rangkaian sumber terbuka yang kuat yang menyokong a. pelbagai Protokol, termasuk HTTP, FTP, SMTP, dll. Dalam PHP, kami boleh membuat permintaan HTTP dengan mudah melalui perpustakaan curl dan mendapatkan data yang dikembalikan oleh API.

Berikut ialah contoh menggunakan perpustakaan curl untuk menghantar permintaan HTTP GET, dengan $url ialah alamat URL antara muka API, $header ialah parameter pengepala permintaan HTTP dan $params ialah GET parameter permintaan HTTP:

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

Jika ia adalah permintaan POST, parameter permintaan boleh dihantar dalam $body dan maklumat pengepala permintaan masih diletakkan dalam $header:

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
curl_close($ch);

The maklumat ralat dan ralat permintaan curl boleh diperolehi melalui fungsi curl_error dan curl_errno.

2. Gunakan fungsi file_get_contents untuk membuat permintaan HTTP

Selain perpustakaan curl, PHP juga menyediakan fungsi file_get_contents untuk mendapatkan kandungan alamat URL, di mana pengepala permintaan HTTP maklumat boleh ditetapkan:

$header = array(
    'Content-type: application/json',
    'Authorization: Bearer ' . $token
);
$options = array(
    'http' => array(
        'method' => 'GET',
        'header' => implode("
", $header)
    )
);
$context = stream_context_create($options);
$response = file_get_contents($url, false, $context);

Kaedah ini juga boleh digunakan untuk permintaan POST, cuma ubah suai kaedah dan parameter pengepala.

3. Gunakan perpustakaan Guzzle untuk permintaan HTTP

Guzzle ialah perpustakaan klien HTTP pihak ketiga untuk PHP yang menyediakan satu siri API yang mudah digunakan dan menyokong HTTP/1.1 dan HTTP /2 , menyokong permintaan tak segerak, dan kedua-dua pengepala permintaan dan pengepala respons boleh disesuaikan. Pasang Guzzle melalui komposer:

composer require guzzlehttp/guzzle

Berikut ialah contoh penggunaan pustaka Guzzle untuk menghantar permintaan HTTP GET, dengan $uri ialah alamat URL antara muka API, $query ialah parameter GET HTTP. request, dan $headers ialah parameter pengepala permintaan HTTP :

$client = new GuzzleHttpClient();
$response = $client->request('GET', $uri, [
    'query' => $query,
    'headers' => $headers
]);
$data = $response->getBody()->getContents();

Permintaan POST juga sangat mudah. ​​Cuma tukar GET dalam kaedah permintaan kepada POST dan letakkan parameter permintaan dalam parameter form_params.

3. Pelaksanaan panggilan antara muka API

Jika API yang anda mahu panggil ialah API pihak ketiga, anda perlu menyemak dokumen API terlebih dahulu untuk memahami kaedah permintaannya, URL, parameter, kembalikan keputusan, dsb. maklumat. Jika anda menulis API sendiri, anda perlu menulis program antara muka API untuk melaksanakan fungsi menerima permintaan, memproses permintaan dan mengembalikan data.

Berikut ialah contoh atur cara antara muka API yang mudah untuk mengembalikan tarikh dan masa semasa:

<?php

if ($_SERVER['REQUEST_METHOD'] === 'GET') {
    $timezone = isset($_GET['timezone']) ? $_GET['timezone'] : 'Asia/Shanghai';
    $datetime = new DateTime('now', new DateTimeZone($timezone));
    $response = array(
        'datetime' => $datetime->format('Y-m-d H:i:s'),
        'timezone' => $timezone
    );
    header('Content-Type: application/json');
    echo json_encode($response);
} else {
    http_response_code(405);
    header('Allow: GET');
    echo 'Method Not Allowed.';
}

Atur cara ini menentukan sama ada untuk mengembalikan tarikh dan masa semasa dengan menilai sama ada kaedah permintaan adalah GET. Jika kaedah permintaan bukan GET, kod status 405 dikembalikan dan pelanggan dimaklumkan bahawa hanya permintaan GET disokong. Program ini menggunakan kelas DateTime dan kelas DateTimeZone untuk mendapatkan tarikh dan masa semasa, dan mengembalikan hasilnya kepada klien dalam format JSON.

4. Ralat pengendalian dan penyahpepijatan

Apabila memanggil antara muka API, anda mungkin menghadapi pelbagai ralat dan pengecualian, seperti ralat sambungan rangkaian, ralat parameter, ralat tindak balas antara muka, dsb. Untuk mengendalikan ralat dan pengecualian dengan lebih baik semasa panggilan API, kami perlu menulis kod pengendalian dan penyahpepijatan yang sepadan supaya masalah dapat ditemui dan diselesaikan tepat pada masanya.

Berikut ialah contoh pengendalian ralat mudah:

<?php

try {
    $client = new GuzzleHttpClient();
    $response = $client->request('GET', 'https://example.com/api/data');
    if ($response->getStatusCode() === 200) {
        // 处理API返回数据
        $data = json_decode($response->getBody()->getContents(), true);
    } else {
        throw new Exception('Invalid response code: ' . $response->getStatusCode());
    }
} catch (Exception $e) {
    // 处理API调用异常
    echo 'Error: ' . $e->getMessage();
}

Kod di atas menggunakan kata kunci cuba dan tangkap untuk mengendalikan ralat semasa panggilan API dengan menangkap pengecualian. Jika kod status HTTP yang dikembalikan oleh API bukan 200, pengecualian akan dilemparkan dan maklumat pengecualian akan dikeluarkan kepada penyemak imbas.

Untuk memudahkan penyahpepijatan, kami boleh menggunakan kelas alat atau klien API untuk ujian dan penyahpepijatan API, seperti Posmen, Insomnia, Swagger, dsb. Alat ini menyediakan maklumat seperti dokumen antara muka API, parameter permintaan, pengepala permintaan, hasil respons dan sejarah penyahpepijatan, yang boleh membantu kami memahami dan menyahpepijat antara muka API dengan lebih baik.

5. Ringkasan

Melalui pengenalan artikel ini, kami telah mempelajari kaedah dan proses pelaksanaan memanggil antara muka API dalam PHP, termasuk menggunakan perpustakaan curl, fungsi file_get_contents dan perpustakaan Guzzle untuk membuat Permintaan HTTP dan tulis antara muka API Program, pengendalian ralat dan penyahpepijatan, dsb. Antara muka API ialah kaedah penyambungan biasa antara aplikasi moden Menguasai pengetahuan dan kemahiran asas panggilan API boleh membantu kami merealisasikan keperluan fungsi aplikasi dengan lebih baik.

Atas ialah kandungan terperinci Kaedah dan pelaksanaan memanggil antara muka API dalam PHP. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!