
Saat ini API yang kita buat belum memiliki dokumentasi. Kita akan membuat dokumentasi
bagaimana cara mengakses API yang telah kita buat.
Tujuan praktek ini adalah untuk :
1. Memahami pentingnya dokumentasi
2. Mampu membuat dokumentasi bagaimana cara mengakses API
Mempersiapkan Docs Generator
1. Install swagger-php plugins. Pada terminal/CommandPrompt ketika command dibawah
ini. composer require zircote/swagger-php
2. Membuat artisan command file. Buat file
app/Console/Commands/SwaggerDocScanner.php
3. Buka file app/Console/Kernel.php, tambahkan code dibawah ini :
4. jalan kan di CMD dengan mengetikan kode di bawah ini :
php artisan swaggerdoc:scan
5. Buat file public/api-docs.html, code nya seperti dibawah ini.
6. Jalankan Lumen Server
7. Pada browser buka : http://localhost:8000/api-docs.html , maka hasil nya seperti berikut :
SELESAI
Membuat Dokumentasi API (Get Request)
1. Buka file app/Http/Controllers/Controller.php, tambahkan code dibawah ini :
2. Buka file app/Http/Controllers/Public/PostsController.php, tambahkan code dibawah ini.
3. Jalankan di CMD ketikan code berikut : php artisan swaggerdoc:scan
4. Pada browser buka http://localhost:8000/api-docs.html
5. Kalau anda click pada button GET, tampilanya seperti ini.
SELESAI
Membuat Dokumentasi API (Post Request)
1. Buka file app/Http/Controllers/AuthController.php, tambahkan code dibawah ini :
2. Pada terminal/CommandPrompt jalankan command di bawah ini,supaya bisa update
docs nya. php artisan swaggerdoc:scan
3. Pada browser buka http://localhost:8000/api-docs.html , jika berhasil maka akan tampil seperti gambar dibawah :
4. Kalau anda click pada button POST, tampilanya seperti ini :
SELESAI
0 Komentar