PHP 的 Kong Admin API：一個與框架無關的用戶端，用於無縫 Kong 閘道管理-php教程-PHP中文網

PHP 的 Kong Admin API：一個與框架無關的用戶端，用於無縫 Kong 閘道管理

Mary-Kate Olsen

發布： 2024-11-06 08:52:02

原創

242 人瀏覽過

Kong Admin API for PHP: A Framework-Agnostic Client for Seamless Kong Gateway Management

我很高興推出Kong Admin API for PHP，這是一個功能強大且獨立於框架的PHP 包，可以簡化與Kong Gateway 的Admin API 的交互。這個套件是我們之前的 Laravel 特定客戶端 (nasrulhazim/kong-gateway-php-client) 的進步，現在將被存檔。

我們的新軟體包為任何 PHP 環境的開發人員提供了多功能解決方案，無論框架如何，都可以靈活地輕鬆管理 Kong Gateway。

為什麼選擇適用於 PHP 的 Kong Admin API？

Kong Gateway 的靈活性、可擴充性和功能使其成為 API 管理的理想選擇。然而，現有的 PHP 客戶端要么依賴特定的框架，要么缺乏強大的靈活性。這個新包滿足了這些需求，提供：

與框架無關的設計：與任何 PHP 框架或自訂項目相容。
全面的 API 支援：透過簡化的 CRUD 操作輕鬆管理 Kong 資源。
可設定的身份驗證：內建基於 API 金鑰的身份驗證，提供安全的存取管理。
模組化設定：依照您的環境自訂 API 的基本 URL、標頭等。
可靠的錯誤處理：透過強大的錯誤處理避免停機，確保穩定的 API 互動。

快速入門指南

以下是幫助您開始使用Kong Admin API for PHP的指南。

安裝

要安裝軟體包，請執行：

composer require cleaniquecoders/kong-admin-api

登入後複製

在 Docker 上設定 Kong

如果您是 Kong 的新手或想在本機開發環境中快速設定它，請查看我們的使用 Docker 設定 Kong Gateway 的指南。本指南提供了在本地運行 Kong 的分步 Docker 設置，非常適合測試和開發。

設定 Kong 網關 API 環回

首先，設定 Kong 以允許在 Admin API 上進行環回連接，從而實現安全、基於標頭的身份驗證。以下是如何使用curl進行設定的範例：

#!/bin/bash

# Create Admin API Service
curl --request POST --url http://localhost:8001/services --data name=admin-api-service --data url='http://localhost:8001'

# Create Admin API Route
curl --request POST --url http://localhost:8001/services/admin-api-service/routes --data 'paths[]=/admin-api' --data name=admin-api-route

# Enable Key Auth on Admin API Service
curl --request POST --url http://localhost:8001/services/admin-api-service/plugins --header 'Content-Type: application/json' --data '{"name":"key-auth","config":{"key_names":["api-key"],"key_in_query":false}}'

# Create Admin API Consumer
curl --request POST --url http://localhost:8001/consumers --data '{"username":"apim","custom_id":"apim"}'

# Create APIM API Key
curl -X POST http://localhost:8001/consumers/apim/key-auth

登入後複製

使用 PHP 的 Kong 管理 API

以下是您可以使用此軟體包執行的常見任務的一些範例：

初始化配置

use CleaniqueCoders\KongAdminApi\Configuration;

$configuration = new Configuration(
    base: 'http://127.0.0.1:8000',
    uri: 'admin-api',
    apiKey: 'your-api-key',
    keyName: 'api-key'
);

登入後複製

建立連接器和客戶端

use CleaniqueCoders\KongAdminApi\Client;
use CleaniqueCoders\KongAdminApi\Connector;

$connector = new Connector($configuration);
$client = new Client($connector);

登入後複製

操作範例

儲存新服務

 use CleaniqueCoders\KongAdminApi\Enums\Endpoint;
 use CleaniqueCoders\KongAdminApi\Request;

 $response = $client->send(
     (new Request)
         ->setEndPoint(Endpoint::SERVICES)
         ->store(['name' => 'Some Service', 'url' => 'http://api.service.com'])
 );

 print_r($response);

登入後複製

更新服務

 $response = $client->send(
     (new Request)
         ->setEndPoint(Endpoint::SERVICES)
         ->update('b3c12a56-1234-4f90-876d-12a5b678abcd', ['url' => 'http://new-example.com'])
 );

 print_r($response);

登入後複製

取得服務

composer require cleaniquecoders/kong-admin-api

登入後複製

刪除服務

#!/bin/bash

# Create Admin API Service
curl --request POST --url http://localhost:8001/services --data name=admin-api-service --data url='http://localhost:8001'

# Create Admin API Route
curl --request POST --url http://localhost:8001/services/admin-api-service/routes --data 'paths[]=/admin-api' --data name=admin-api-route

# Enable Key Auth on Admin API Service
curl --request POST --url http://localhost:8001/services/admin-api-service/plugins --header 'Content-Type: application/json' --data '{"name":"key-auth","config":{"key_names":["api-key"],"key_in_query":false}}'

# Create Admin API Consumer
curl --request POST --url http://localhost:8001/consumers --data '{"username":"apim","custom_id":"apim"}'

# Create APIM API Key
curl -X POST http://localhost:8001/consumers/apim/key-auth

登入後複製

新增外掛程式 您可以使用自訂配置新增插件，例如速率限制：

use CleaniqueCoders\KongAdminApi\Configuration;

$configuration = new Configuration(
    base: 'http://127.0.0.1:8000',
    uri: 'admin-api',
    apiKey: 'your-api-key',
    keyName: 'api-key'
);

登入後複製