Kong Admin API untuk PHP: Pelanggan Rangka Kerja-Agnostik untuk Pengurusan Gerbang Kong Seamless

Saya teruja untuk memperkenalkan API Kong Admin untuk PHP, pakej PHP yang berkuasa dan bebas rangka kerja yang memudahkan interaksi dengan API Pentadbiran Kong Gateway. Pakej ini adalah satu langkah daripada pelanggan khusus Laravel kami yang terdahulu (nasrulhazim/kong-gateway-php-client), yang kini akan diarkibkan.

Pakej baharu kami menawarkan penyelesaian serba boleh untuk pembangun merentas mana-mana persekitaran PHP, memberikan fleksibiliti untuk mengurus Kong Gateway dengan mudah, tanpa mengira rangka kerja.

Mengapa API Pentadbir Kong untuk PHP?

Fleksibiliti, skalabiliti dan ciri Kong Gateway menjadikannya sesuai untuk pengurusan API. Walau bagaimanapun, pelanggan PHP sedia ada sama ada terikat pada rangka kerja tertentu atau tidak mempunyai fleksibiliti yang mantap. Pakej baharu ini memenuhi keperluan ini, menyediakan:

• Reka Bentuk Rangka Kerja-Agnostik: Serasi dengan mana-mana rangka kerja PHP atau projek tersuai.
• Sokongan API Komprehensif: Urus sumber Kong dengan mudah dengan operasi CRUD yang diperkemas.
• Pengesahan Boleh Dikonfigurasikan: Pengesahan berasaskan kunci API terbina dalam, menawarkan pengurusan akses selamat.
• Persediaan Modular: Sesuaikan URL asas API, pengepala dan banyak lagi untuk persekitaran anda.
• Pengendalian Ralat Boleh Dipercayai: Elakkan masa henti dengan pengendalian ralat yang mantap, memastikan interaksi API yang stabil.

Panduan Mula Pantas

Di bawah ialah panduan untuk membantu anda bermula dengan API Kong Admin untuk PHP.

Pemasangan

Untuk memasang pakej, jalankan:

composer require cleaniquecoders/kong-admin-api

Menyediakan Kong pada Docker

Jika anda baru menggunakan Kong atau ingin menyediakannya dengan cepat dalam persekitaran pembangunan tempatan, lihat panduan kami tentang Menyediakan Kong Gateway dengan Docker. Panduan ini menyediakan persediaan Docker langkah demi langkah untuk menjalankan Kong secara tempatan, sesuai untuk ujian dan pembangunan.

Mengkonfigurasi Kong Gateway API Loopback

Mula-mula, konfigurasikan Kong untuk membenarkan sambungan gelung balik pada API Pentadbiran, mendayakan pengesahan berasaskan pengepala yang selamat. Berikut ialah contoh cara menyediakannya dengan 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

Menggunakan Kong Admin API untuk PHP

Berikut ialah beberapa contoh tugas biasa yang boleh anda lakukan dengan pakej ini:

1. Mulakan Konfigurasi
   

   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. Buat Penyambung dan Pelanggan
   

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

3. Contoh Operasi

• Simpan Perkhidmatan Baharu
  

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

• Kemas kini Perkhidmatan
  

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

• Dapatkan Perkhidmatan
  

  composer require cleaniquecoders/kong-admin-api
  

• Padamkan Perkhidmatan
  

  #!/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. Tambah Pemalam Anda boleh menambah pemalam, seperti pengehadan kadar, dengan konfigurasi tersuai:

use CleaniqueCoders\KongAdminApi\Configuration;

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

Perlukan Bantuan dengan Kong API Gateway?

Berfikir tentang melaksanakan Kong sebagai gerbang API anda atau memerlukan bantuan untuk mengoptimumkan persediaan anda? Kami menawarkan perundingan tentang menyediakan dan mengkonfigurasi Kong Gateway untuk pengurusan API yang lancar. Anda boleh menjadualkan temu janji di sini: Tempah perundingan.

Kesimpulan

API Kong Admin untuk PHP menyediakan penyelesaian yang fleksibel dan boleh dipercayai untuk mengurus sumber API Kong Gateway. Dengan sokongan untuk berbilang rangka kerja dan pilihan konfigurasi yang mantap, ia direka bentuk untuk menyepadukan dengan mudah dan memperkasakan pembangun dengan kawalan penuh ke atas ciri berkuasa Kong.

---

Foto oleh Codioful (Dahulu Gradienta) di Unsplash

Atas ialah kandungan terperinci Kong Admin API untuk PHP: Pelanggan Rangka Kerja-Agnostik untuk Pengurusan Gerbang Kong Seamless. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!