Kong Admin API for PHP: シームレスな Kong ゲートウェイ管理のためのフレームワークに依存しないクライアント

Kong Admin API for PHP を紹介できることを嬉しく思います。これは、Kong Gateway の Admin API とのやり取りを簡素化する強力でフレームワークに依存しない PHP パッケージです。このパッケージは、以前の 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 ゲートウェイのセットアップに関するガイドを参照してください。このガイドでは、テストと開発に最適な、Kong をローカルで実行するための段階的な Docker セットアップを説明します。

Kong ゲートウェイ API ループバックの構成

まず、Admin API でのループバック接続を許可するように Kong を構成し、安全なヘッダーベースの認証を有効にします。以下は、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 Admin API の使用

このパッケージを使用して実行できる一般的なタスクの例をいくつか示します:

1. 構成の初期化
   

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

2. コネクタとクライアントの作成
   

   use CleaniqueCoders\KongAdminApi\Client;
   use CleaniqueCoders\KongAdminApi\Connector;
   
   $connector = new Connector($configuration);
   $client = new Client($connector);
   

3. 操作例

• 新しいサービスを保存する
  

   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
  

1. プラグインを追加 カスタム構成を使用して、レート制限などのプラグインを追加できます。

use CleaniqueCoders\KongAdminApi\Configuration;

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

Kong API ゲートウェイについてサポートが必要ですか?

Kong を API ゲートウェイとして実装することを検討していますか? それともセットアップを最適化するためのサポートが必要ですか?シームレスな API 管理を実現するための Kong ゲートウェイのセットアップと構成に関するコンサルティングを提供します。ここで予約をすることができます: 相談を予約する

結論

Kong Admin API for PHP は、Kong Gateway の API リソースを管理するための柔軟で信頼性の高いソリューションを提供します。複数のフレームワークと堅牢な構成オプションをサポートしているため、簡単に統合でき、開発者が Kong の強力な機能を完全に制御できるように設計されています。

---

Unsplash 上の Codioful (旧 Gradienta) による写真

以上がKong Admin API for PHP: シームレスな Kong ゲートウェイ管理のためのフレームワークに依存しないクライアントの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。