PHP Lumen Service Docs

Dalam tutorial kali ini saya akan bahas tentang Lumen Service Docs. Saat ini API yang kita buat belum memiliki dokumentasi. Kita akan membuat dokumentasi bagaimana cara mengakses API yang telah kita buat.

Mempersiapkan Docs Generator

Untuk membuat docs generator kita akan menggunakan swagger-ui
( https://swagger.io/tools/swagger-ui/ ). Untuk membuatnya, silahkan ikuti langkah-langkah dibawah ini:

Install swagger-php plugins di projek lumen-service kalian. Pada terminal/CommandPrompt ketik command dibawah ini.

composer require zircote/swagger-php

Jika sudah selesai selanjutnya buat artisan command file. Buat file di app/Console/Commands/SwaggerDocScanner.php. Lalu masukan kode di bawah ini.

Buka file app/Console/Kernel.php, tambahkan code dibawah ini.

Untuk menjalankan artisan command SwaggerDocScanner dan menggenerate docs, pada terminal/CommandPrompt jalankan command dibawah. Command ini akan membuat file public/swaggerdoc.json. Saat ini kalau dijalankan, command ini bakal error, karena kita belum mendefiniskan anotasi docs nya.

php artisan swaggerdoc:scan

Untuk tampilan User Interface nya kita perlu mebuat file html di public folder. Buat file: public/api-docs.html, code nya seperti dibawah ini.

Run Lumen Server

Pada browser buka http://localhost:8000/api-docs.html

Membuat Dokumentasi API (Get Request)

Kita akan membuat API dokumentasi untuk endpoint /post/public. Untuk membuat dokumentasi API mengenai get Request, silahkan ikuti langkah-langkah dibawah ini:
Buka file app/Http/Controllers/Controller.php, tambahkan code dibawah ini.

Buka file app/Http/Controllers/Public/PostsController.php, tambahkan code dibawah ini.

Pada terminal/CommandPrompt jalankan command di bawah ini. Setiap kali anda mengubah anotasi docs, harus menjalankan command di bawah ini supaya bisa update docs nya.

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html

Kalau anda click pada button GET, tampilanya seperti ini.

SIlahkan anda melakukan Try it out.

Membuat Dokumentasi API (Post Request)
Kita akan membuat API dokumentasi untuk endpoint /register. Untuk membuat dokumentasi API mengenai Post Request, silahkan ikuti langkah-langkah dibawah ini:
Buka file app/Http/Controllers/AuthController.php, tambahkan code dibawah ini.

Pada terminal/CommandPrompt jalankan command di bawah ini. Setiap kali anda mengubah anotasi docs, harus menjalankan command di bawah ini supaya bisa update docs nya

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html

Silakan coba Try it out.

Membuat dokumentasi untuk semua endpoint

Pertama kita akan membuat untuk endpoint login user.
Tambahkan kode berikut di App\Http\Controllers\AuthController.php

Pada terminal/CommandPrompt jalankan command di bawah ini untuk update docsnya

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html, dan akan muncul menu login

Silakan klik post login, dan klik Try it out, dan masukan user yang ada di database.

Jika berhasil responnya seperti ini:

Tambahkan kode berikut ke App\Http\Controllers\Controller.php
untuk menambahkan fitru authorization agar semua endpoint post jika kita akses maka membutuhkan token.

Pada terminal/CommandPrompt jalankan command di bawah ini untuk update docsnya

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html

Selanjutnya tambahkan kode berikut untuk membuat endpoint show di App\Http\Controllers\PublicController\PostsController.php

Pada terminal/CommandPrompt jalankan command di bawah ini untuk update docsnya

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html

Membuat dokumentasi untuk endpoint /posts

Sebelumnya kita telah membuat endpoint untuk /public/posts. sekarang kita akan membuat dokumentasi endpoint /posts.
Tambahkan kode-kode berikut di setiap function di App\Http\Controllers\PostsController.php

Pada terminal/CommandPrompt jalankan command di bawah ini untuk update docsnya

php artisan swaggerdoc:scan

Pada browser buka http://localhost:8000/api-docs.html

Sekarang kita coba di setiap endpoint.
Pertama kita perlu login terlebih dahulu untuk mendapat token agar bisa mengakses semua endpointnya.
Klik POST /auth/login dan klik Try it out

Masukan email dan passwordnya. jika berhasil maka akan keluar token seperti pada gambar berikut:

Selanjutnya klik tombol Authorize dan masukan token yang tadi:

Lanjut kita coba yang get posts, klik Try it out dan klik Execute

Jika berhasil seperti pada gambar berikut:

Selanjutnya kita akan mencoba Create new Posts, klik Try it out, masukan valuenya dan klik Execute

Jika berhasil akan seperti pada gambar

Selanjutnya kita akan mencoba Get Post By id, klik Try it out, masukan id dan klik Execute

Jika berhasil akan seperti pada gambar

Selanjutnya kita akan mencoba Update Posts, klik Try it out, masukan valuenya dan klik Execute

Jika berhasil akan seperti pada gambar

Selanjutnya kita akan mencoba Delete Posts, klik Try it out, masukan id yang akan dihapus dan klik Execute

Jika berhasil akan seperti pada gambar

Selesai.

PHP Lumen Client App

Kali ini Kita akan membuat aplikasi (Client) yang bisa melakukan request ke Web Service (API) menggunakan PHP Lumen.

Sebelumnya kita membuat aplikasi Web Service menggunakan Lumen. Saat ini kita akan membuat aplikasi yang bisa mengakses Web Service menggunakan Lumen (kita sebut dengan aplikasi Client).

Aplikasi Lumen Service App Sebagai Web Service API

Untuk implementasi Lumen Client App, kita kan membuat aplikasi Web Service CRUD akses Rest API menggunakan Dummy API yang di akses di

http://dummy.restapiexample.com/

Pertama kita harus mengintal projek lumennya dengan composer.

silakan ketik di cmd/Command Prompt :

composer create-project --prefer-dist laravel/lumen [NAMA_PROJECT]

Contoh : 

composer create-project --prefer-dist laravel/lumen LumenClientApp

Untuk menjalankan kode ini harus memiliki koneksi internet dan tunggu hingga proses instalasi selesai.

untuk menjalankan server nya silahkan jalankan script ini di cmd/command prompt dan masuk ke direktory projeknya.

dan kita akan menggunakan port 9000.

ketikan : php -S localhost:9000 -t public : seperti pada gambar

Silahkan buka http://localhost:9000 di browser











Pertama kita kan membuat fungsi  read all employee. masukan kode ini di router/web.php

Kemudian buatlah sebuah controller dengan nama EmployeeController.php di Folder App/Http/Controllers dan masukan function index sebagai berikut:

Selanjutnya buatlah folder di folder resources/views dengan nama folder employee dan buatlah file index.php, dan masukan kode berikut:

Selanjutnya test endpoint di browser http://localhost:9000/employee
jika berhasil tampilannya sebagai berikut:










Selanjutnya kita akan membuat fungsi detail employee, tambahkan kode ini di router/web.php

Kemudian tambahkan function show di EmployeeController.php

Selanjutnya tambahkan file baru di folder resources/views/employee dengan nama show.php dan masukan kode berikut:

Silakan masukan endpoint berikut http://localhost:9000/employee/[id] ditambah id yang ingin kita lihat detailnya.












Selanjutnya kita akan membuat fungsi create employee.
Pertama masukan kode berikut di routes/web.php

Kemudian tambahkan kode di EmployeeController.php function store sebagai berikut:

Selanjutnya tambahkan file baru di folder resources/views/employee dengan nama store.php dan masukan kode berikut:

Silakan masukan endpoint berikut http://localhost:9000/create
jika berhasil hasilya seperti ini









Selanjutya kita akan membuat fungsi update employee masukan kode routes berikut:

Kemudian tambahkan kode di EmployeeController.php function update sebagai berikut:

Selanjutnya tambahkan file baru di folder resources/views/employee dengan nama update.php dan masukan kode berikut:

Silakan masukan endpoint berikut http://localhost:9000/update/[id] ditambah id yang ingin kita lihat ubah.










Yang terakhir kita akan membuat fungsi delete employee. Tambahkan kode routes berikut:

Kemudian tambahkan kode di EmployeeController.php function destroy sebagai berikut:

Silakan masukan endpoint berikut http://localhost:9000/delete/[id] ditambah id yang ingin kita lihat ubah.










selesai.