PHP dan Laravel berintegrasi untuk melaksanakan dokumentasi dan ujian antara muka Swagger

Dalam persekitaran Internet yang semakin terbuka hari ini, API telah menjadi cara utama untuk pelbagai aplikasi untuk berkomunikasi antara satu sama lain Dengan antara muka API, kami boleh menyambungkan pelbagai aplikasi antara satu sama lain untuk mencapai pemandangan yang lebih kompleks. Walau bagaimanapun, penulisan dan penyelenggaraan dokumen antara muka API, serta ujian antara muka, adalah tugas yang agak sukar. Untuk menyelesaikan masalah ini, dokumentasi antara muka Swagger dan alat ujian telah wujud.

Swagger ialah rangka kerja terstandard dan lengkap untuk menjana, menerangkan, menggunakan dan menggambarkan perkhidmatan web gaya RESTful. Swagger ialah sumber terbuka pada GitHub dan dikekalkan dalam OpenAPI. Swagger membantu pembangun dalam mereka bentuk, membina, mendokumenkan dan menguji API RESTful sepanjang kitaran hayat mereka. Untuk pembangun PHP, anda boleh menggunakan Swagger PHP dan integrasi Laravel untuk menulis dan memaparkan dokumen antara muka API.

Artikel ini akan memperkenalkan cara menggunakan PHP dan Laravel untuk menyepadukan Swagger untuk menulis dan menguji dokumen antara muka API.

1. Pasang Swagger PHP

Mula-mula, kita perlu memasang pakej Swagger PHP. Ia boleh dipasang melalui Komposer, buka terminal, masukkan direktori projek Laravel, dan laksanakan arahan berikut:

composer memerlukan zirkot/swagger-php

2. Pasang Swagger UI

Swagger UI ialah halaman interaktif sumber terbuka untuk Memaparkan dokumentasi API yang ditakrifkan oleh spesifikasi Swagger. Ia termasuk perpustakaan bahagian hadapan untuk memaparkan dokumentasi API menggunakan Swagger, ReDoc dan Swagger-UI. Anda boleh memasangnya melalui npm atau memuat turun terus kod sumber UI Swagger.

Di sini, kami menggunakan Composer untuk memasang dan melaksanakan arahan berikut:

composer memerlukan darkaonline/l5-swagger

3. Konfigurasikan Swagger PHP

Selepas pemasangan selesai, kami perlu menambah Laraggervel fail konfigurasi. Buka fail config/app.php, cari tatasusunan penyedia dan tambahkan konfigurasi berikut:

`
'providers' => [

...
DarkaonlineL5SwaggerL5SwaggerServiceProvider::class,

],

'aliases' => [

...
'Swagger' => DarkaonlineL5SwaggerFacadesSwaggerL5::class,

]
`

Selesai Selepas konfigurasi, jalankan arahan berikut untuk menerbitkan fail konfigurasi swagger, pandangan, penghalaan dan fail lain:

php vendor artisan:publish --provider "L5SwaggerL5SwaggerServiceProvider"

4. Menulis anotasi Swagger

Anotasi sombong. Anotasi Swagger adalah untuk menambah beberapa pernyataan khusus pada komen kod untuk memberitahu alat Swagger parameter, nilai pulangan, kaedah permintaan, alamat penghalaan dan maklumat lain API. . id)

{

// 根据ID获取用户信息

}
`

Kami menggunakan anotasi @SWGGet di atas anotasi kod untuk menerangkan kaedah permintaan dan alamat penghalaan antara muka, dan menambah ringkasan, teg, parameter, respons dan anotasi lain untuk memberitahu Swagger alat lebih lanjut mengenai antara muka butiran lain.
• Jana dokumentasi Swagger
• Selepas melengkapkan penulisan anotasi Swagger, kami boleh menjana dokumentasi API Swagger. Buka terminal, masukkan direktori projek Laravel, dan masukkan arahan berikut untuk menjana dokumen:
• php artisan l5-swagger:generate
• Selepas pelaksanaan, dokumen Swagger API akan dijana secara automatik dan boleh diakses melalui pelayar http ://your_host/api /documentation Lihat dokumentasi. Halaman ini menunjukkan semua antara muka API kami, termasuk kaedah permintaan, parameter, hasil pemulangan dan butiran lain.
• 6. Uji antara muka API

  Selepas melengkapkan penulisan dan paparan dokumen API, kami juga perlu menguji antara muka API. Dalam dokumentasi API Swagger, kami boleh menguji antara muka API dengan mengklik butang "Cubalah". Di sini, kami boleh memasukkan parameter permintaan secara manual, dan kemudian klik butang "Laksanakan" untuk membuat permintaan secara automatik akan memulakan permintaan ke pelayan dan memaparkan hasil tindak balas. Dengan cara ini, kami boleh menguji antara muka API melalui alat Swagger.

  Ringkasan

  Menggunakan Swagger PHP dan integrasi Laravel, adalah sangat mudah untuk menulis dokumen antara muka API yang sempurna, dan antara muka boleh diuji. Dalam aplikasi praktikal, alat Swagger boleh meningkatkan kecekapan pembangunan dan mengurangkan berlakunya ralat. Adalah disyorkan bahawa pembangun menggunakan alat Swagger secepat mungkin untuk meningkatkan pengurusan dan penyelenggaraan antara muka API, dengan itu meningkatkan kebolehpercayaan dan kestabilan aplikasi.

Atas ialah kandungan terperinci PHP dan Laravel berintegrasi untuk melaksanakan dokumentasi dan ujian antara muka Swagger. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!