Official Blog of Akhdani Reka Solusi

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

Haloo kreatif readers.. kali ini saya saya akan membahas tentang salah satu framework PHP yaitu Yii.

Pengenalan Yii

Framework Yii merupakan sebuah framework PHP berbasis komponen yang memiliki performa yang baik. Framework ini bisa digunakan untuk membangun aplikasi berbasis web berskala kecil hingga berskala besar.

Yii mulai dikembangkan pada awal bulan Januari 2008 oleh Qiang Xue.  Saat ini Yii telah tersedia versi 2, sebuah versi yang merupakan lompatan besar dari versi sebelumnya (varian 1.1) dan lebih modern.

Yii merupakan framework PHP lain pada umumnya, dapat digunakan untuk membangun berbagai jenis aplikasi berbasis web, misalnya: web portal, forum, CMS, e-commerce, web service, dan masih banyak yang lainnya. Yii juga memiliki fitur-fitur yang umum dimiliki oleh framework lainnya, seperti MVC (model-view-controller), mendukung banyak basis data, ORM, caching, RESTful, code generator, dsb.

Kelebihan dari framework Yii yaitu:

1. Memiliki Fitur dan Panduan yang Lengkap
   Yii memiliki fitur yang sangat lengkap seperti tersedianya banyak extension yang bisa kita gunakan atau library–library PHP yang dengan mudah bisa kita integrasikan dengan Yii. Selain itu panduan yang disediakan juga lengkap dan rapi misalnya pada dokumentasi API Yii yang mudah dibaca karena tersusun rapi dengan penjelasan yang mudah dimengerti.

2. Adanya Komunitas Besar dan Aktif
   Yii memiliki komunitas yang besar sehingga diharapkan ketika kita menghadapi masalah dalam belajar atau pengembangan aplikasi berbasis Yii akan banyak yang membantu.

3. Memiliki Kode Generator Ajaib
   Yii memiliki kode generator (Gii) yang berfungsi meng-generate kode template model, crud, form, dsb. Sehingga akan mempercepat pemrogram aplikasi dalam membangun sebuah aplikasi. Menariknya, tools ini bisa dengan mudah dikustomisasi sesuai dengan keinginan kita.

4. Peningkatan Kemanan
   Yii memiliki beberapa fungsi keamanan built-in yang mudah digunakan, antara lain untuk pencegahan SQL injections, XSS attacks, CSRF attacks, cookie tampering, dsb.

5. Otentikasi dan Otorisasi
   Yii secara built-in mendukung fitur otentikasi dan otorisasi pengguna, seperti: login, logout, cookie-based dan otentikasi berbasis token, access control filter dan role-based access control (RBAC). Di samping itu juga mendukung OpenID, OAuth1 dan OAuth2 protocols.

6. Didukung oleh fitur-fitur unggulan lainnya seperti:
   – URL SEO Friendly yang bernama pretty URL.
   – Mendukung berbagai jenis cache (APC, Memcache, files, basis data, dsb) pada berbagai level aplikasi, baik dari sisi client (HTTP caching) maupun server (fragment caching, dan query caching)
   – Built-in Twitter Bootstrap.
   – Secara built–in Yii juga menyediakan tools untuk uji coba aplikasi yaitu Codeception dan Faker.

Adapun beberapa kekurangan dari framework Yii yaitu:

1. Bukan merupakan framework yang paling populer.
2. Kurang promosi, sehingga menyebabkan framework menjadi kurang populer.
3. Update tergolong jarang, sehingga dikhawatirkan akan lambat untuk mengadopsi teknologi baru.
4. Kecepatan Yii berada di tengah, banyak framework PHP lain yang memiliki kecepatan jauh melampaui Yii.

Arsitektur Yii

Untuk application project template Yii hadir dengan dua pilihan template yaitu Basic dan Advanced. Masing-masing memiliki peruntukannya sendiri, namun bagi pemula, direkomendasikan untuk menggunakan template Basic. Hal ini dikarenakan template ini simple yang terdiri dari satu aplikasi,  dan base-nya adalah template Basic. Adapun template Advanced direkomendasikan untuk pembuatan sebuah proyek aplikasi yang besar, dimana aplikasi backend terpisah dengan frontend.

Alur Kerja Yii

Sama seperti framework PHP lainnya, Yii mengimplementasi konsep MVC (Model-View-Controller) dimana file-file model view dan controller dibuat terpisah. Berikut ini gambaran alur kerja aplikasi yang menggunakan framework Yii menggunakan konsep MVC:

Alur kerja aplikasi Yii dimulai dari user yang mengakses aplikasi Yii melalui entry script, selanjutnya dilakukan konfigurasi untuk menjalankan aplikasi. Aplikasi tersebut routing yang diminta oleh user melalui URL sehingga diketahui controller yang dimaksud user, kadangkala proses dalam aplikasi ini membutuhkan komponen tertentu sehingga dipanggillah suatu komponen tersebut. Setelah masuk ke controller yang dimaksud, controller menciptakan action berdasarkan routing. Sebelum action benar-benar tercipta maka dilakukan pengecekan atau filter terhadap action tersebut (misalnya: filter otorisasi yaitu apakah action tersebut boleh diakses oleh current user). Jika tidak lolos filter maka controller akan mengembalikan response ke user dan siklus berakhir, namun jika lolos filter maka action akan diproses. Pada action akan dimuat model (jika menggunakan model), demikian juga jika model membutuhkan basis data (active record) maka akan dilakukan pengaksesan basis data. Selanjutnya pada action tersebut akan dilakukan render terhadap suatu view (jika menggunakan view) untuk kemudian view tersebut ditampilkan ke user, dan siklus berakhir.

Referensi:
Mukhlasin, Hafidz. Membangun Aplikasi Profesional Berbasis Web Menggunakan Yii Framework. 2017. Jakarta: Buku Baik.

Hallo kreatif readers, pada kesempatan kali ini, kita akan menjelajahi Laminas MVC Framework.

Laminas MVC Framework, sebagaimana dipresentasikan dalam buku “Laminas: MVC Framework” oleh Adam Omelak, merupakan alat yang kuat untuk pengembangan aplikasi web berbasis PHP. Framework ini menawarkan pendekatan yang modular, struktur MVC yang kuat, dan berbagai fitur canggih untuk memudahkan pengembangan aplikasi yang kuat dan scalable.

Apa itu Laminas MVC Framework?

Laminas (sebelumnya dikenal sebagai Zend Framework) adalah framework PHP yang memungkinkan pengembang untuk membangun aplikasi web yang canggih dan scalable. Berfokus pada modularitas, Laminas memungkinkan penggunaan komponen-komponennya secara terpisah, memberikan fleksibilitas tinggi dalam pengembangan.

Fitur Utama Laminas MVC Framework:

1. Modularitas yang Tinggi

Laminas dirancang dengan pendekatan modular, memungkinkan pengembang untuk menggunakan komponen-komponennya secara independen. Ini mempermudah pengelolaan kode dan penggunaan hanya fitur-fitur yang diperlukan.

2. Struktur MVC (Model-View-Controller)

Framework ini mengadopsi pola desain Model-View-Controller (MVC), yang memisahkan logika aplikasi, presentasi, dan manipulasi data. Ini meningkatkan keterbacaan kode dan memudahkan pemeliharaan.

3. Dukungan untuk Middleware

Laminas memberikan dukungan untuk middleware, memungkinkan penanganan permintaan dan respons HTTP secara fleksibel. Middleware dapat digunakan untuk menambahkan fungsi-fungsi tambahan dalam alur pemrosesan.

4. Manajemen Dependensi dengan Composer

Framework ini menggunakan Composer untuk manajemen dependensi dan autoload classes. Ini membuat pengelolaan dependensi menjadi lebih efisien dan memastikan ketergantungan hanya dimuat saat dibutuhkan.

5. Dokumentasi yang Komprehensif

Laminas menyediakan dokumentasi yang komprehensif dan panduan pengembangan yang mendalam. Ini membantu pengembang, dari yang baru hingga berpengalaman, memahami konsep-konsep dan implementasi framework.

Kelebihan Laminas MVC Framework:

1. Skalabilitas dan Keterbacaan Kode: Modularitas dan struktur MVC membuat Laminas cocok untuk proyek-proyek kecil hingga besar, meningkatkan skalabilitas dan keterbacaan kode.
2. Fleksibilitas Penggunaan Komponen: Pengembang dapat menggunakan komponen-komponen Laminas secara terpisah, menambahkan ke fleksibilitas dan kemampuan untuk menyesuaikan aplikasi sesuai kebutuhan.
3. Dukungan Keamanan Terintegrasi: Laminas memiliki fitur-fitur keamanan terintegrasi, membantu pengembang melindungi aplikasi dari serangan umum.
4. Komunitas yang Aktif: Sebagai proyek open source, Laminas memiliki komunitas pengembang yang aktif. Ini berarti dukungan reguler, pembaruan, dan pertanyaan-pertanyaan yang dijawab.

Referensi: Laminas MVC Framework for PHP, Adam Omelak, Second Edition Tahun 2023.

Halo Kreatif Readers!! Kali ini aku mau sharing tentang salah satu framework PHP yaitu Zend. Selamat membaca….

Apa itu Zend Framework?

Referensi 
Judul Buku : Zend Framework 2.X Solusi Mempercepat Pengembangan Aplikasi    Berbasis Web dengan PHP5.x Framework
Penulis : Edison siregar
Tahun : 2015
Edisi : 1