Apa itu REST API di laravel: Semua yang perlu Anda ketahui

Diterbitkan: 2022-11-03

Dunia benar-benar beralih ke kemudahan menggunakan perangkat seluler dan mencari solusi secara online. Desain web dan pengembangan web mengalami kemajuan pesat di dunia saat ini.

Sebagian besar permintaan telah beralih ke smartphone karena pengembangan situs web juga mencakup pengembangan aplikasi seluler. Karena itu, untuk aplikasi seluler, backend memerlukan API yang tenang.

Jika Anda tidak tahu apa itu REST API, tidak apa-apa! Kami membantu Anda.

Di blog ini, saya akan menjelaskan apa itu restful API dan bagaimana cara kerjanya. Saya juga akan menjelaskan cara mengembangkan API yang tenang di Laravel.

Mari kita mulai…

Apa itu REST API?

API adalah antarmuka pemrograman aplikasi, yang membantu kita untuk menghubungkan satu perangkat ke perangkat lain, misalnya pasangan kita memiliki satu situs web langsung dan sekarang kita ingin membangun satu aplikasi seluler sehingga kita akan membuat API untuk menghubungkan data ke perangkat, kita harus menggunakan JSON data untuk diteruskan ke perangkat sehingga ini hanya dapat dilakukan dengan API.

Terkadang, ada kebutuhan untuk API komunikasi jaringan atau API Transfer Negara Representasi.

Bagaimana cara kerjanya?

Pada awalnya kita harus menginstal aplikasi laravel di sistem kita sehingga kita dapat mengikuti dokumentasi resmi laravel yang akan membantu kita untuk melangkah lebih jauh. Berikut link dokumen yang dapat diikuti untuk menginstal aplikasi laravel:

http://laravel.com/

Untuk menginstal aplikasi silakan gunakan perintah ini tetapi pastikan Anda harus memiliki komposer di sistem Anda, karena komposer adalah alat ketergantungan yang membantu menginstal semua dependensi dalam aplikasi, Anda dapat mengikuti tautan ini:

https://getcomposer.org/download/

Setelah Anda menginstal composer, Anda dapat mengunduh laravel, silakan gunakan perintah ini:

komposer buat-proyek --prefer-dist laravel/laravel laravel-sanctum-auth

Setelah proyek terinstal maka perlu mengatur detail database dalam file .ENV jadi cukup isi nane database Anda di file ENV.

bagaimana cara kerjanya Langkah selanjutnya adalah menginstal paket API. Ada banyak paket yang tersedia tetapi Anda dapat menginstal sesuai pilihan Anda.

Jadi untuk menginstal paket, Anda harus mengikuti perintah sesuai yang diberikan dalam dokumentasi laravel. Karena saya akan menggunakan Sanctum, saya akan menggunakan perintah ini:

komposer membutuhkan laravel/sanctum

  Setelah saya menjalankan perintah ini, paket saya akan diinstal dan siap digunakan. Cukup ikuti tangkapan layar di bawah ini: Bagaimana cara kerjanya 2

Setelah kita selesai dengan setup paket, langkah selanjutnya adalah membuat model untuk database. Kami akan membuat satu mode dan migrasi yang akan terhubung ke database langsung,

app/Model/User.php file.

<?php

namespace App\Models;

gunakan Illuminate\Contracts\Auth\MustVerifyEmail;

gunakan Illuminate\Database\Eloquent\Factories\HasFactory;

gunakan Illuminate\Foundation\Auth\User sebagai Otentikasi;

gunakan Illuminate\Notifications\Notifiable;

// tempat suci

gunakan Laravel\Sanctum\HasApiTokens;

kelas Pengguna meluas Dapat Diotentikasi

{

gunakan HasApiTokens, HasFactory, Notifiable;

 

/**

* Atribut yang dapat dialihkan secara massal.

*

* @var array

*/

dilindungi $dapat diisi = [

'nama',

'surel',

'kata sandi',

];

 

/**

* Atribut yang harus disembunyikan untuk array.

*

* @var array

*/

dilindungi $tersembunyi = [

'kata sandi',

'remember_token',

];

 

/**

* Atribut yang harus dilemparkan ke tipe asli.

*

* @var array

*/

dilindungi $cast = [

'email_verified_at' => 'waktu tanggal',

];

}

Bagaimana cara kerjanya 3

  Sekarang kita harus membuat satu pengontrol jadi silakan gunakan perintah ini untuk membuat pengontrol

Php artisan make::controller CONTROLLER NAME

app/Http/Controllers/API/BaseController.php file:

<?php



namespace App\Http\Controllers\API;

gunakan Illuminate\Http\Request;

gunakan App\Http\Controllers\Controller sebagai Pengendali;



kelas BaseController memperluas Controller

{

/**

* metode respons sukses.

*

* @return \Illuminate\Http\Response

*/

fungsi publik sendResponse($result, $message)

{

$tanggapan = [

'sukses' => benar,

'data' => $hasil,

'pesan' => $pesan,

];

 

return response()->json($response, 200);

}



/**

* kembalikan respons kesalahan.

*

* @return \Illuminate\Http\Response

*/

fungsi publik sendError($error, $errorMessages = [], $code = 404)

{

$tanggapan = [

'berhasil' => salah,

'pesan' => $kesalahan,

];

 

if(!empty($errorMessages)){

$response['data'] = $errorMessages;

}

 

return response()->json($response, $code);

}

}

Harap diperhatikan: Setiap kali kami membuat API, kami selalu mengirimkan respons dalam JSON dengan kode status.

Bagaimana cara kerjanya 4

Untuk API kami selalu membuat token auth. Artinya jika token akan dibuat dan diverifikasi, maka kita dapat mengotentikasi pengguna.

<?php

namespace App\Http\Controllers\API;

gunakan Illuminate\Http\Request;

gunakan App\Http\Controllers\API\BaseController sebagai BaseController;

gunakan Illuminate\Support\Facades\Auth;

menggunakan Validator;

gunakan App\Models\User;

kelas AuthController memperluas BaseController

{

masuk fungsi publik (Permintaan $ permintaan)

{

if(Auth::attempt(['email' => $request->email, 'password' => $request->password])){

$authUser = Auth::user();

$success['token'] = $authUser->createToken('MyAuthApp')->plainTextToken;

$sukses['nama'] = $authUser->nama;

return $this->sendResponse($success, 'User masuk');

}

kalau tidak{

return $this->sendError('Unauthorized.', ['error'=>'Unauthorized']);

}

}

pendaftaran fungsi publik(Permintaan $permintaan)

{

$validator = Validator::make($request->all(), [

'nama' => 'wajib',

'email' => 'wajib|email',

'sandi' => 'wajib',

'confirm_password' => 'wajib|sama:sandi',

]);

if($validator->fails()){

return $this->sendError('Error validasi', $validator->errors());

}

$masukan = $permintaan->semua();

$input['kata sandi'] = bcrypt($input['kata sandi']);

$pengguna = Pengguna::buat($input);

$success['token'] = $user->createToken('MyAuthApp')->plainTextToken;

$sukses['nama'] = $pengguna->nama;

return $this->sendResponse($success, 'Pengguna berhasil dibuat.');

}

}

File rute ini:

Bagaimana cara kerjanya 5 Terakhir, untuk menjalankan proyek, kita perlu menjalankan perintah ini:

php artisan serve

Membungkus

API mendukung banyak situs web dan layanan terpopuler saat ini, mulai dari jejaring sosial hingga aplikasi keuangan. Di blog ini, Anda diperkenalkan dengan REST API di Laravel. Kami harap ini meletakkan dasar untuk pemahaman Anda tentang apa itu REST API dan cara kerjanya.

Jika Anda mencari layanan pengembangan web, Anda tidak perlu mencari lebih jauh. Di webdew, Anda akan dapat menemukan tim proaktif dari desainer dan pengembang web yang terampil untuk merancang dan membangun situs web bisnis Anda. Hubungi kami untuk mengetahui lebih banyak.