Month: January 2024

Haloo kreatif reader.. kali ini aku mau bahas tentang Dokumentasi API L5 Swagger pada Laravel.

Dokumentasi API adalah dokumentasi yang berisi kumpulan panduan penggunaan API terhadap suatu program atau aplikasi. Dokumentasi API ini digunakan sebagai acuan untuk mendeskripsikan API secara menyeluruh sehingga penggunaan API dapat mudah dipahami oleh seluruh tim pengembang ataupun pengembangan lain untuk pemeliharaan aplikasi selanjutnya.

Salah satu tools  yang dapat digunakan untuk mendokumentasikan API adalah Swagger. Swagger merupakan framework populer yang digunakan untuk OpenAPI Specification (OAS). Penggunaan swagger dapat menyederhanakan proses dokumentasi API secara  interaktif. Dokumentasi yang dihasilkan dapat dengan mudah dipahami oleh pengguna teknis maupun non-teknis.

Saat ini swagger sudah dapat digunakan langsung pada framework Laravel dalam bentuk package L5 Swagger yang bekerja dengan mengadaptasi swagger-php dan swagger-ui.

Untuk melakukan instalasi dan setup L5 Swagger pastikan laravel dan composer sudah terinstall di laptop pengguna. Setelah itu ikuti langkah-langkah instalasi package l5swagger berikut ini:

1. Install package l5 swagger melalui composer

composer requires darkonline/l5-swagger tymon/jwt-auth

2. Publish file konfigurasi L5Swagger

php artisan vendor: publish --provider "L5Swagger\L5SwaggerServiceProvider"

3. Konfigurasi Swagger
Buka file config/l5-swagger.php dan sesuaikan pengaturan misalnya dengan mengonfigurasi path API documentation, keamanan, dan lainnya.

4. Tambah anotasi swagger ke Route dan Controllers
Contoh penggunaan anotasi pada route:

/**
* @OA\Get(
* path="/api/user",
* summary="Get a list of users",
* tags={"Users"},
* @OA\Response(response=200,
* description="List of users",
* ),
* )
*/

Contoh penggunaan anotas pada contollers

/**
* @OA\Info(
* title="Swagger with Laravel",
* version="1.0.0",
* )
* @OA\SecurityScheme(
* type="http",
* securityScheme="bearerAuth"
* scheme="bearer"
* bearerFormat="JWT"
* )
*/

5. Generate dokumentasi Swagger

php artisan l5-swagger:generate

Perintah ini akan menghasilkan file JSON swagger dan secara default menyimpannya di direktori publik.

6. Akses halaman swagger dengan mengunjungi url yang telah dibuat pada file konfigurasi. Contohnya ‘http://your-app-url/api/documentation’

Berikut ini contoh tampilan hasil generate dokumentasi swagger:

Dengan penggunaan l5 swagger yang mudah diimplementasi ini, diharapkan dapat mendorong kolaboarasi yang lebih baik dan mempercepat pengembangan API pada aplikasi laravel yang dibuat.

---

Referensi:
Upadhyay, Mayur. (2024, January 04). Laravel Swagger Integration: A Step-by-Step-Guide. WPWEB Infotech.
Kolodii, Ivan. (2020, May 10). How to write Swagger Documentation for Laravel API. Tips & Example. Medium. 

Hallo Kreatif Reader…. Kali ini, aku mau sharing nih mengenai integrasi laravel dengan No SQL. Semoga bermanfaat

Laravel adalah kerangka pengembangan web populer untuk PHP. Laravel menawarkan banyak default dan menyediakan struktur kode yang mudah dipahami dan cepat digunakan untuk mengimplementasikan aplikasi web dan API. MongoDB memiliki integrasi resmi dengan Laravel, dan paket terseut tersedia di GitHub.

Integrasi Laravel dengan basis data NoSQL seperti MongoDB dapat dilakukan dengan cukup mudah, karena Laravel mendukung beberapa driver basis data NOSQL. MongoDB adalah salah satu pilihan populer untuk basis data NoSQL, dan kita akan fokus pada integrasi Laravel dengan MongoDB.

Berikut adalah langkah – langkah  umum untuk integrasi Laravel dengan MongoDB:

1. Instalsi MongoDB dan Ekstensi PHP MongoDB:

Pastikan MongiDB telah terinstal di server anda

Instal ekstensi PHP MongoDB dengan menggunakan Composer:

composer require jenssegers/mongodb

2. Konfigurasi koneksi ke MongoDB

Buka berkas ‘config/database.php’ dan tambahkan konfigurasi untuk mongoDB:

'mongodb' => [
 'driver' => 'mongodb',
 'host' => env('DB_HOST', 'localhost'),
 'port' => env('DB_PORT', 27017),
 'database' => env('DB_DATABASE', 'your_database'),
 'username' => env('DB_USERNAME', 'your_username'),
 'password' => env('DB_PASSWORD', 'your_password'),
 'options' => [
 'database' => 'admin',
 ],
],

Sesuaikan nilai ‘database’, ‘username’, dan ‘password’ sesuai dengan konfigurasi MongoDB

3. Atur koneksi pada Berkas.env

Sesuaikan nilai ‘DB_Connection’ dan kredensial MongoDB pada berkas ‘.env':

DB_CONNECTION=mongodb
DB_HOST=127.0.0.1
DB_PORT=27017
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

4. Gunakan model Eloquent MongoDB:

Buat model Eloquent untuk menggunakan MongoDB. Misalkan, jika anda memiliki model ‘Book’, buat file ‘Book.php':

<?php

namespace App;

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class Book extends Eloquent
{
 protected $connection = 'mongodb';
 protected $collection = 'books';
 protected $fillable = ['title', 'author', 'published_at'];
}

Pastikan untuk menyesuaikan nilai – nilai seperti ‘$collection’ sesuai dengan struktur database anda.

5. Migrasi dan penggunaan model:

Buat migrasi untuk struktur MongoDB jika diperlukan:

php artisan make:migration create_books_collection

Gunakan model Eloquent seperti menggunakan model biasa pada Laravel

Referensi

Judul Buku: Belajar Cepat Database NoSQL, Menggunakan Document Priented Databse (MongoDB) pada Pengaplikasian Big Data

Penulis: Agit Amrullah &Kusnawi

Penerbit: Penerbit ANDI

MongoDB