Cara menggunakan Swagger Codegen untuk menjana kod klien dan pelayan API dalam PHP

Swagger ialah spesifikasi dokumentasi API standard yang mentakrifkan format yang boleh dibaca untuk menerangkan struktur dan pengendalian API. Swagger Codegen ialah alat yang membolehkan anda menjana kod klien dan pelayan API secara automatik daripada spesifikasi Swagger. Dalam PHP, menggunakan Swagger Codegen boleh menjana kod klien dan pelayan API PHP dengan mudah, menjimatkan banyak masa dan usaha.

Berikut akan memperkenalkan cara menggunakan Swagger Codegen untuk menjana klien API dan kod pelayan dalam PHP.

Langkah 1: Pasang alat Swagger Codegen

Mula-mula, anda perlu memasang alat Swagger Codegen. Ia boleh dimuat turun melalui halaman projek Swagger Codegen di GitHub, atau dipasang melalui perduaan yang telah disusun sebelumnya atau menggunakan bekas Docker.

Langkah 2: Tulis fail spesifikasi Swagger

Seterusnya, anda perlu menulis fail spesifikasi Swagger, iaitu fail JSON atau YAML yang menerangkan struktur, operasi, parameter dan maklumat lain bagi API itu. Jika anda tidak tahu cara menulis fail spesifikasi Swagger, anda boleh menciptanya menggunakan antara muka grafik dalam Editor Swagger (https://editor.swagger.io/).

Apabila anda selesai menulis fail spesifikasi, sila simpan sebagai fail format swagger.json atau swagger.yaml dan pastikan fail itu mengandungi maklumat yang diperlukan, seperti maklumat asas API, penghalaan, parameter dan maklumat lain.

Langkah 3: Gunakan Swagger Codegen untuk menjana kod klien PHP

Gunakan arahan berikut untuk menjana kod klien PHP:

swagger-codegen generate -i swagger.yaml -l php -o client/php

Di mana, swagger.yaml ialah kod yang anda baru sahaja Laluan fail bagi fail spesifikasi Swagger yang ditulis, client/php ialah direktori projek yang digunakan untuk menjana kod klien PHP.

Selepas ini, Swagger Codegen akan menjana kod klien PHP secara automatik dan menjana perpustakaan klien API yang mengandungi semua operasi API yang ditakrifkan dalam fail spesifikasi Swagger.

Langkah 4: Gunakan Swagger Codegen untuk menjana kod pelayan PHP

Gunakan arahan berikut untuk menjana kod pelayan PHP:

swagger-codegen generate -i swagger.yaml -l php-server -o server/php

Di mana, swagger.yaml ialah kod yang anda baru sahaja Laluan fail bagi fail spesifikasi Swagger yang ditulis, server/php ialah direktori projek yang digunakan untuk menjana kod pelayan PHP.

Selepas ini, Swagger Codegen akan menjana kod pelayan PHP secara automatik dan menjana perpustakaan pelayan API yang mengandungi semua operasi API yang ditakrifkan dalam fail spesifikasi Swagger.

Langkah 5: Gunakan kod klien dan pelayan yang dijana

Selepas ini, anda boleh menggunakan kod klien dan pelayan PHP yang dijana untuk memanggil API anda. Hanya rujuk perpustakaan kod klien dan pelayan dan gunakan fungsi dan kaedah mereka untuk mengakses API.

Sebagai contoh, jika anda menjana kod klien PHP, anda boleh menggunakan kod berikut untuk memanggil API:

require_once(__DIR__ . '/client/php/autoload.php');

$apiInstance = new SwaggerClientApiDefaultApi();
$param = new SwaggerClientModelParam(); // SwaggerClientModelParam 为您在Swagger规范文件中定义的参数模型类
$param->setId(1);

try {
    $result = $apiInstance->getOperation($param);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getOperation: ', $e->getMessage(), PHP_EOL;
}

Jika anda menjana kod pelayan PHP, anda boleh menggunakan kod yang anda tentukan dalam Laluan spec swagger yang ditakrifkan dalam fail untuk mengendalikan permintaan API.

Ringkasan

Gunakan Swagger Codegen untuk menjana kod klien dan pelayan API PHP dengan mudah. Sebelum menggunakannya, pastikan anda telah menulis fail spesifikasi Swagger dan ia mengandungi semua operasi dan parameter API yang anda perlukan. Kemudian hanya gunakan alat Swagger Codegen untuk menjana kod untuk mula menggunakan API anda.

Atas ialah kandungan terperinci Cara menggunakan Swagger Codegen untuk menjana kod klien dan pelayan API dalam PHP. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!