使用 PHP 存取並解析 Api 的返回數據-php教程-PHP中文網

使用 PHP 存取並解析 Api 的返回數據

WBOY

發布： 2023-06-13 08:28:02

原創

1492 人瀏覽過

隨著網路的發展和普及，各種應用程式對於資料的需求越來越大。為了獲得更多的數據，第三方的 API (Application Programming Interface) 被越來越多地使用。 API 是指一個應用程式提供的一些指令或接口，可以用來存取一個應用程式的後端資料。在這篇文章中，我們將介紹如何使用 PHP 存取並解析 API 的回傳資料。

什麼是 API

API 是縮寫，全名為 Application Programming Interface，翻譯過來就是應用程式介面。它通常指一個軟體或服務的一些接口，可以讓其他軟體或服務來存取它的後端資料或功能。 API 是針對開發者的，通常是透過 HTTP（Hypertext Transfer Protocol，超文本傳輸協定）協定來進行通訊的。

使用 API 可以幫助我們取得一些開放的資料、查詢一些服務、取得一些資源等等。例如，我們可以使用天氣 API 來存取一個地區的天氣資料（溫度、風速、降雨等）；我們可以使用新聞 API 來取得新聞的標題、內容、作者、發佈時間等等。

透過 PHP 存取 API

接下來我們將介紹如何使用 PHP 來存取 API。首先我們需要知道獲取資料的幾種常見方法：GET、POST、PUT、DELETE。這裡我們只介紹 GET 方法。

2.1 使用 file_get_contents 函數

PHP 提供了一個 file_get_contents 函數，可以用來從遠端伺服器取得資料。我們可以使用這個函數來存取 API 並取得返回資料。

例如，我們可以存取一個JSON 格式的API，程式碼如下：

<?php
$url = 'https://jsonplaceholder.typicode.com/users/1';
$data = file_get_contents($url);
echo $data;
?>

登入後複製

這個例子中，我們使用file_get_contents 函數來存取一個RESTful API（REpresentational State Transfer，表述性狀態轉移），這個API 可以回傳一個使用者的訊息，我們要求的是id 為1 的使用者資訊。取得到的資料是一個 JSON 格式的字串，我們使用 echo 函數將它輸出到頁面上。

2.2 使用 cURL 函數

除了使用 file_get_contents 函數，我們也可以使用 cURL 函數來取得資料。 cURL 是一個用來傳輸檔案和資料的工具，它可以透過很多協定傳輸數據，包括 HTTP、FTP、SFTP 等。

例如，我們可以使用cURL 函數來存取一個JSON 格式的API，程式碼如下：

<?php
$url = 'https://jsonplaceholder.typicode.com/users/1';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$data = curl_exec($ch);
curl_close($ch);
echo $data;
?>

登入後複製

這個範例中，我們使用curl_init 函數初始化一個cURL 會話，使用curl_setopt 函數來設定cURL選項。設定 CURLOPT_URL 選項來指定請求的 URL，設定 CURLOPT_RETURNTRANSFER 選項來告訴 cURL 函數將請求結果以字串形式傳回。最後使用 curl_exec 函數執行會話，並使用 curl_close 函數關閉會話。所獲得的數據和上一個例子相同。

解析傳回的資料

我們取得到的資料通常是字串，我們需要將它解析成PHP 中的物件或數組，才能得到正確的數據。通常我們取得到的資料有以下幾種格式：

3.1 JSON 格式

JSON（JavaScript Object Notation）是一種輕量級的資料交換格式，可以被多種程式語言支持。它使用鍵值對的方式來表示數據，包括數組、物件、字串、數字等。

我們可以使用 PHP 提供的 json_decode 函數將 JSON 格式的字串解析成 PHP 中的物件或陣列。例如，我們可以使用以下程式碼來將一個JSON 格式的字串解析成一個PHP 陣列：

<?php
$data = '[{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]';
$arr = json_decode($data, true);
print_r($arr);
?>

登入後複製

這個例子中，我們使用json_decode 函數將一個JSON 格式的字串解析成一個PHP 數組，並使用print_r 函數將陣列輸出到頁面上。注意第二個參數 true 表示傳回的是一個數組，而不是一個物件。如果不設定這個參數，則預設回傳一個物件。

3.2 XML 格式

XML（Extensible Markup Language）是一種標記語言，可以用來表示文件和資料。它使用標記來描述資料的結構和語義。

我們可以使用 PHP 提供的 SimpleXML 擴充功能來解析 XML 格式的字串。例如，我們可以使用以下程式碼來將一個XML 格式的字串解析成一個PHP 物件：

<?php
$data = '<?xml version="1.0" encoding="UTF-8"?>
<users>
    <user>
        <id>1</id>
        <name>Alice</name>
    </user>
    <user>
        <id>2</id>
        <name>Bob</name>
    </user>
</users>';
$xml = simplexml_load_string($data);
print_r($xml);
?>

登入後複製

這個例子中，我們使用simplexml_load_string 函數將一個XML 格式的字串解析成一個PHP 對象，並使用print_r 函數將物件輸出到頁面上。

總結

使用 PHP 存取並解析 API 的回傳資料是一個非常常見的需求。我們常常需要從遠端伺服器取得數據，並使用它來更新本機應用程式。本文介紹如何使用 PHP 存取 API，並解析回傳資料。我們介紹了兩種取得資料的方法：file_get_contents 函數和 cURL 函數，並介紹了兩種資料格式的解析方法：JSON 格式和 XML 格式。這些方法在實際開發中非常有用，我們可以使用它們來存取各種開放的 API，從而獲得更多的資料和資源。

以上是使用 PHP 存取並解析 Api 的返回數據的詳細內容。更多資訊請關注PHP中文網其他相關文章！