Kong Admin API für PHP: Ein Framework-unabhängiger Client für die nahtlose Kong Gateway-Verwaltung

Ich freue mich, die Kong Admin API für PHP vorzustellen, ein leistungsstarkes und Framework-unabhängiges PHP-Paket, das die Interaktion mit der Admin API von Kong Gateway vereinfacht. Dieses Paket ist eine Weiterentwicklung unseres vorherigen, Laravel-spezifischen Clients (nasrulhazim/kong-gateway-php-client), der jetzt archiviert wird.

Unser neues Paket bietet eine vielseitige Lösung für Entwickler in jeder PHP-Umgebung und bietet die Flexibilität, Kong Gateway unabhängig vom Framework problemlos zu verwalten.

Warum Kong Admin API für PHP?

Die Flexibilität, Skalierbarkeit und Funktionen von Kong Gateway machen es ideal für die API-Verwaltung. Allerdings waren die vorhandenen PHP-Clients entweder an bestimmte Frameworks gebunden oder es fehlte ihnen an robuster Flexibilität. Dieses neue Paket geht auf diese Bedürfnisse ein und bietet Folgendes:

• Framework-Agnostisches Design: Kompatibel mit jedem PHP-Framework oder benutzerdefinierten Projekt.
• Umfassende API-Unterstützung: Verwalten Sie Kong-Ressourcen mühelos mit optimierten CRUD-Vorgängen.
• Konfigurierbare Authentifizierung: Die API-schlüsselbasierte Authentifizierung ist integriert und bietet eine sichere Zugriffsverwaltung.
• Modulares Setup: Passen Sie die Basis-URL, Header und mehr der API an Ihre Umgebung an.
• Zuverlässige Fehlerbehandlung: Vermeiden Sie Ausfallzeiten durch robuste Fehlerbehandlung und sorgen Sie für stabile API-Interaktionen.

Schnellstartanleitung

Im Folgenden finden Sie eine Anleitung, die Ihnen den Einstieg in die Kong Admin API für PHP erleichtert.

Installation

Um das Paket zu installieren, führen Sie Folgendes aus:

composer require cleaniquecoders/kong-admin-api

Kong auf Docker einrichten

Wenn Sie neu bei Kong sind oder es schnell in einer lokalen Entwicklungsumgebung einrichten möchten, lesen Sie unseren Leitfaden zum Einrichten von Kong Gateway mit Docker. Diese Anleitung bietet eine Schritt-für-Schritt-Anleitung für die Docker-Einrichtung für die lokale Ausführung von Kong, ideal zum Testen und Entwickeln.

Kong Gateway API Loopback konfigurieren

Konfigurieren Sie Kong zunächst so, dass Loopback-Verbindungen auf der Admin-API zugelassen werden, um eine sichere, Header-basierte Authentifizierung zu ermöglichen. Hier ist ein Beispiel für die Einrichtung mit 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

Verwendung der Kong Admin API für PHP

Hier sind einige Beispiele für häufige Aufgaben, die Sie mit diesem Paket ausführen können:

1. Konfiguration initialisieren
   

   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. Connector und Client erstellen
   

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

3. Beispieloperationen

• Neuen Dienst speichern
  

   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);
  

• Einen Dienst aktualisieren
  

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

• Holen Sie sich einen Service
  

  composer require cleaniquecoders/kong-admin-api
  

• Einen Dienst löschen
  

  #!/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. Plugin hinzufügen Sie können Plugins wie Ratenbegrenzung mit benutzerdefinierten Konfigurationen hinzufügen:

use CleaniqueCoders\KongAdminApi\Configuration;

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

Benötigen Sie Hilfe mit Kong API Gateway?

Denken Sie darüber nach, Kong als Ihr API-Gateway zu implementieren, oder benötigen Sie Hilfe bei der Optimierung Ihres Setups? Wir bieten Beratungen zum Einrichten und Konfigurieren von Kong Gateway für ein nahtloses API-Management an. Hier können Sie einen Termin vereinbaren: Beratung vereinbaren.

Abschluss

Kong Admin API für PHP bietet eine flexible und zuverlässige Lösung für die Verwaltung der API-Ressourcen von Kong Gateway. Durch die Unterstützung mehrerer Frameworks und robuster Konfigurationsoptionen ist es für eine einfache Integration konzipiert und ermöglicht Entwicklern die volle Kontrolle über die leistungsstarken Funktionen von Kong.

---

Foto von Codioful (ehemals Gradienta) auf Unsplash

Das obige ist der detaillierte Inhalt vonKong Admin API für PHP: Ein Framework-unabhängiger Client für die nahtlose Kong Gateway-Verwaltung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!