Techtalk BSI UII : Lumen X Swagger

swagger - open api specification

 

Ada banyak tools yang dapat digunakan untuk melakukan testing API, salah satunya adalah dengan menggunakan Swagger. Pada artikel kali ini, kita akan membahas tentang integrasi Swagger dengan framework Lumen.

Apa itu Swagger?

Swagger adalah tools yang digunakan untuk mendokumentasikan API atau web service
yang dibangun. Swagger dapat diakses melalui https://swagger.io/

Open API Specification

Pada 1 Januari 2016, Swagger Specification diubah namanya menjadi OpenAPI Specification serta dipindahkan ke repositori perangkat lunak baru di GitHub.

Lebih terstruktur serta programmable yang menjelaskan bagaimana suatu API tertentu bekerja, karakteristik serta output yang akan dihasilkan.

Contoh Open API

https://swagger.io/docs/specification/about/

Dibawah ini adalah contoh konfigurasi endpoint Get :

Dibawah ini adalah contoh setting definisi info secara global :

 

Swagger UI

UI interaktif yang dapat digunakan di browser untuk memvisualisasikan definisi OpenAPI Specification.

https://swagger.io/tools/swagger-editor/

 

 

SwaggerLume

Paket ini adalah pembungkus Swagger-php dan swagger-ui yang diadaptasi untuk bekerja dengan Lumen.

https://github.com/DarkaOnLine/SwaggerLume

 

Template

Template Open Api Specification yang bisa digunakan.

https://github.com/zircote/swagger-php/tree/3.x/Examples/petstore-3.0

 

 

Simak proses integrasi Lumen dan Swagger dalam video berikut ini :

 

Kesimpulan

  • Swagger UI membuat desain API menjadi lebih mudah dengan menggunakan tools yang mudah digunakan oleh pengembang.
  • Swagger UI Open
  • Bisa di implementasikan dengan framework
  • Perlu mempelajari Open Api Spesification lebih mendalam, untuk penggunaan yang lebih

 

Artikel ini disarikan dari pelaksanaan Techtalk Badan Sistem Informasi UII yang terlaksana pada tanggal 21 April 2022. Disampaikan oleh Duwi Haryanto dari tim HCM Badan Sistem Informasi UII. (GS)