如何用PHP創建SOAP API：詳細教程和示例代碼

gitbox 2025-06-15

介紹SOAP API

SOAP（簡單對象訪問協議）是一種基於XML的協議，用於交換結構化信息，它在創建Web服務時被廣泛使用。 SOAP API允許不同操作系統和編程語言之間進行交互，能夠支持多種協議和標準。

在這篇文章中，我們將展示如何使用PHP創建SOAP API，幫助你理解SOAP協議的基本操作。

前提條件

在開始編寫SOAP API之前，了解以下基礎知識將會對你有所幫助：

SOAP協議的基礎知識
PHP編程基礎

創建SOAP服務器

要在PHP中創建SOAP API，你首先需要在服務器端設置一個SOAP服務器。以下是一個簡單的例子：

 
// 創建SOAP伺服器
$server = new SoapServer("example.wsdl");
// 註冊API函數
function sayHello($name) {
  return "Hello, " . $name;
}
$server->addFunction("sayHello");
// 處理請求
$server->handle();

解釋代碼

在上面的代碼中，首先創建了一個SOAP服務器並指定WSDL文件的路徑，WSDL文件描述了SOAP服務的功能和接口。

接著，我們定義了一個簡單的API函數`sayHello`，它接收一個參數$name並返回字符串。最後，通過`addFunction`將函數添加到SOAP服務器中，並調用`handle()`處理請求。

創建SOAP客戶端

為了與SOAP API交互，我們需要創建一個SOAP客戶端。以下是客戶端的代碼示例：

 
// 創建SOAP客戶端
$client = new SoapClient("example.wsdl");
// 調用API函數
$response = $client->sayHello("World");
echo $response;  // 輸出 "Hello, World"

解釋代碼

在客戶端代碼中，我們創建了一個SOAP客戶端，並指定WSDL文件的路徑。接著，我們調用了`hello`函數並傳遞了"World"作為參數。

最後，我們輸出返回的字符串`"Hello, World"`。

使用SOAP API傳遞複雜數據類型

除了簡單的數據類型，SOAP API還可以傳遞複雜的對象和數組。以下是一個使用對像作為參數的示例：

 
// 創建对象
class Person {
  public $name;
  public $age;
}
// 創建SOAP伺服器
$server = new SoapServer("example.wsdl");
// 註冊API函數
function sayHelloToPerson($person) {
  return "Hello, " . $person->name . " (" . $person->age . ")";
}
$server->addFunction("sayHelloToPerson");
// 處理請求
$server->handle();

在上面的代碼中，我們定義了一個`Person`類，並包含`name`和`age`兩個屬性。然後，我們創建了一個函數`sayHelloToPerson`，它接收一個`Person`對象，並返回一個包含該對象屬性的字符串。

客戶端可以像下面這樣傳遞一個`Person`對象：

 
// 創建对象
$person = new stdClass();
$person->name = "John";
$person->age = 30;
// 創建SOAP客戶端
$client = new SoapClient("example.wsdl");
// 調用API函數
$response = $client->sayHelloToPerson($person);
echo $response;  // 輸出 "Hello, John (30)"

解釋代碼

在客戶端代碼中，我們首先創建了一個`Person`對象，並為其設置`name`和`age`屬性。然後，我們創建了一個SOAP客戶端，並調用`sayHelloToPerson`函數傳遞這個對象，最後輸出結果。

結論

通過本文，你已經學會瞭如何使用PHP創建SOAP API。 SOAP協議為開發跨平台Web服務提供了強大的支持，適用於需要高安全性、可靠性的場景。你可以根據自己的需求，創建不同類型的Web服務，並與其他系統進行交互。