PHP Lumen Service Docs

PHP Lumen Service Docs

Halo teman - teman pada tutorial kali ini akan melanjutkan mengenai PHP Lumen dan tutorial kali ini akan membahas PHP Lumen Service Docs silahkan perhatikan dan ikuti tutorial di bawah ini.

Sebelum itu nyalakan fitur apache dna mysql di xampp

Penjelasan

Pada tutorial kali ini akan menjelaskan pembuatan dokumentasi penggunaan dari aplikasi PHP Lumen seperti pemanggilan api dan data yang terdapat dalam api tersebut.

Mempersiapkan Docs Generator

Untuk membuat Docs Generator kita menggunakan aplikasi swagger-ui yang bisa di lihat di link ini
untuk pembuatan nya bisa mengikuti langkah - langkah di bawah ini :

1. Install swagger php plugins dengan memasukan perintah composer require zircote/swagger-php pada terminal dan instalasi ini harus terkoneksi ke internet lalu akan muncul tampilan seperti gambar dibawah ini

Apabila instalasi sudah selesai maka akan muncul tampilan seperti ini

2. Lalu buat file SwaggerDocScanner.php di folder app/http/commands dan masukan kode seperti ini

3. Lalu buka file Kernel.php di folder app/Console dan masukan kodingan dari baris ke  15 - 18 pada gambar di bawah ini

4. Lalu jalankan perintah php artisan swaggerdoc:scan dan akan muncul tampilan error

5. Lalu buat file api-docs.html di folder public dan masukan kode seperti ini

6. Jalankan perintah php -S localhost:8000 -t public dan akan muncul tampilan seperti ini

7. Lalu akan muncul tampilan seperti ini

Selesai

Membuat Dokumentasi API (Get Request)

Langkah selanjutnya yaitu membuat tampilan API untuk melakukan register dengan method get dan  untuk langkah - langkah nya bisa dilihat di bawah ini

1. Buka file Controller.php yang ada di folder app/http/controllers dan tambahkan kode dari baris ke 7-21 pada gambar di bawah ini

untuk penulisan pada baris ini harus berbentuk comment dan harus sesuai persis dengan gambar di atas

2. Lalu masih di folder Controller buka file PostController dan tambahkan kode dari baris ke 12 - 26 seperti gambar di bawah ini

3. Lalu jalankan perintah php artisan swaggerdoc:scan di terminal dan akan muncul tampilan seperti ini 

4 Lalu buka kembali http://localhost:8000/api-docs.html dan akan muncul tampilan seperti ini

5. Apabila di klik button get maka akan muncul tampilan seperti ini

6. Lalu apabila mengklik button try out maka akan muncul tampilan seperti ini

7. Dan apabila di klik button execute akan muncul tampilan seperti ini

Apabila muncul data pada tabel post maka pembuatan dokumentasi api berhasil

Selesai

Membuat Dokumentasi API (Post Request)

Pada tutorial selanjutnya yaitu membuat dokumentasi API tetapi untuk method nya berbentuk post request bisa mengikuti langkah - langkah di bawah ini

1. Buka file AuthController.php di folder app/http/controller dan masukan kode dari baris ke 9 - 41 seperti gambar di bawah ini

2. Lalu jalankan kembali perintah php artisan swaggerdoc:scan di terminal dan akan muncul tampilan seperti ini 

3. Lalu buka kembali link http://localhost:8000/api-docs.html di browser dan akan muncul tampilan seperti ini

4. Apabila di klik button post maka akan muncul tampilan seperti ini

5. Apabila melakukan cara yang sama seperti pada method get maka akan muncul tampilan seperti ini

Selesai

OK mungkin untuk tutorial nya sampai disini terlebih dahulu silahkan di coba konfigurasinya dan terima kasih telah mengikuti tutorial kali ini