PHP melaksanakan sistem platform pengurusan API sumber terbuka

PHP melaksanakan sistem platform pengurusan API sumber terbuka

Dengan pembangunan berterusan perkhidmatan Web, API Web telah menjadi bahagian penting dalam era Web 2.0. API Web menyediakan banyak fungsi dan antara muka untuk aplikasi, membolehkan kami membina pelbagai aplikasi dengan lebih ringkas dan mudah. Walau bagaimanapun, mengurus dan mengekalkan sejumlah besar API boleh menjadi pening kepala. Oleh itu, sistem platform pengurusan API sumber terbuka sangat diperlukan.

Artikel ini akan memperkenalkan cara menggunakan PHP untuk melaksanakan sistem platform pengurusan API sumber terbuka.

Persediaan alam sekitar

Untuk menjalankan sistem platform pengurusan API sumber terbuka kami, kami memerlukan persekitaran berikut:

1. PHP
2. MySQL
3. Apache/Nginx

Sudah tentu, anda juga boleh menggunakan pelayan web lain dan bukannya Apache atau Nginx.

Rangka Kerja Sistem

Kami menggunakan rangka kerja PHP Laravel untuk membina sistem platform pengurusan API sumber terbuka kami. Laravel ialah rangka kerja PHP popular yang direka bentuk dengan cantik serta mudah digunakan serta diselenggara.

Pasang Laravel

Pasang versi terkini Laravel menggunakan arahan berikut:

projek cipta komposer --prefer-dist laravel/laravel api-manager

Perintah ini akan mencipta projek baharu bernama api-manager dalam direktori semasa dan memasang Laravel serta kebergantungan berkaitannya secara automatik.

Buat Pangkalan Data

Kami perlu mencipta pangkalan data dalam MySQL dan mengaitkannya dengan aplikasi kami. Kita boleh menggunakan arahan berikut untuk mencipta pangkalan data baharu dalam MySQL:

CREATE DATABASE api_manager;

Kemas kini maklumat konfigurasi pangkalan data

Buka fail .env api-manager projek dan ubah Maklumat berikut dikemas kini dengan maklumat sambungan MySQL anda:

DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api_manager
DB_USERNAME=root
DB_PASSWORD >

Pasang dan konfigurasikan Swagger

Swagger ialah alat dokumentasi API yang popular yang boleh membantu kami mengatur dan memaparkan dokumentasi API dengan lebih baik. Kita boleh memasang Swagger menggunakan arahan berikut:

komposer memerlukan "darkaonline/swagger-lume:5.8.*"

Selepas berjaya memasang Swagger, kita perlu menambah yang berikut dalam konfigurasi/aplikasi Fail .php Kandungan:

// Daftar Penyedia Swagger

$app->register(SwaggerLumeServiceProvider::class);

// Daftar Terbitkan

$app-> configure(' swagger-lume');
$app->register(SwaggerLumeServiceProvider::class);

// Terbitkan konfigurasi, paparan dan aset

$this->publishes([

__DIR__.'/../config/swagger-lume.php' => config_path('swagger-lume.php'),

], 'config');

Tambahkan paparan Swagger pada fail route/web.php aplikasi anda:

$router->get('/' , function () use ($router) {

return view('swagger');

});

Ini akan memaparkan dokumentasi Swagger di bawah laluan akar aplikasi kami.

Buat Pengawal API

Kita perlu mencipta pengawal dalam aplikasi pengurus api untuk mengendalikan permintaan API. Kita boleh mencipta pengawal menggunakan arahan berikut:

php artisan make:controller ApiController

Ini akan mencipta fail pengawal baharu yang dipanggil ApiController.php dalam direktori app/Http/Controllers .

Dalam fail ApiController.php, tambahkan kod berikut:

ruang nama AppHttpControllers;

gunakan IlluminateHttpRequest;

kelas ApiController memanjangkan Pengawal

{

public function list()
{
    return response()->json(['status' => 'success', 'message' => 'API list']);
}

public function get($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id]);
}

public function create(Request $request)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$name.' created']);
}

public function update(Request $request, $id)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$id.' updated']);
}

public function delete($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id.' deleted']);
}

}

Kod di atas mentakrifkan kaedah operasi biasa API untuk kami: senarai, dapatkan, cipta, kemas kini, padam.

Konfigurasi penghalaan API

Kita perlu menambah kod berikut dalam fail route/api.php:

$router->group(['prefix' => ; ' api'], function () use ($router) {

// List APIs
$router->get('list', 'ApiController@list');

// Get API
$router->get('get/{id}', 'ApiController@get');

// Create API
$router->post('create', 'ApiController@create');

// Update API
$router->put('update/{id}', 'ApiController@update');

// Delete API
$router->delete('delete/{id}', 'ApiController@delete');

});

Ini akan mentakrifkan penghalaan permintaan untuk setiap API untuk kami.

Menguji API

Kami boleh menggunakan alatan seperti Posmen untuk menguji API kami. Dalam Posman, anda boleh menggunakan URL permintaan berikut untuk menguji API:

GET http://localhost:8000/api/list

GET http://localhost:8000/api/get/1
POST http://localhost:8000/api/create
LETAKKAN http://localhost:8000/api/update/1
PADAM http://localhost:8000/api/delete/1

Akhir sekali, mulakan pelayan tempatan dan laksanakan arahan berikut:

php artisan serve

Sekarang, kita boleh membuka http://localhost:8000/ dalam pelayar untuk melihat sistem platform pengurusan API sumber terbuka kami. Pada masa yang sama, kami juga boleh mengakses API kami di http://localhost:8000/api. Dalam Swagger, kita boleh melihat dokumentasi API dan menguji pelbagai fungsi API.

Kesimpulan

Tidak sukar untuk melaksanakan sistem platform pengurusan API sumber terbuka dengan PHP. Menggunakan rangka kerja Laravel dan alatan Swagger, kami boleh membina sistem platform pengurusan API yang lengkap dengan sangat mudah.

Menguasai sistem platform pengurusan API sumber terbuka akan membawa anda membuka laluan baharu dan menjadikan dunia aplikasi web anda lebih menarik dan mengujakan.

Atas ialah kandungan terperinci PHP melaksanakan sistem platform pengurusan API sumber terbuka. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!