Cos'è l'API REST in laravel: tutto ciò che devi sapere

Pubblicato: 2022-11-03

Il mondo si sta completamente orientando verso la facilità di utilizzo dei dispositivi mobili e la ricerca di soluzioni online. Il web design e lo sviluppo web stanno progredendo in misura massiccia nel mondo di oggi.

La maggior parte della domanda è stata rivolta agli smartphone poiché lo sviluppo di siti Web comprende anche lo sviluppo di app mobili. Detto questo, per le app mobili, il back-end richiede un'API riposante.

Se non sai cos'è l'API REST, va bene! Ti abbiamo coperto.

In questo blog spiegherò cos'è l'API riposante e come funziona. Spiegherò anche come sviluppare un'API riposante in Laravel.

Iniziamo…

Che cos'è l'API REST?

APi è un'interfaccia di programmazione delle applicazioni, che ci aiuta a connettere un dispositivo a un altro dispositivo, ad esempio coniuge abbiamo un sito Web live e ora vogliamo creare un'app mobile, quindi creeremo un'API per connettere i dati al dispositivo, dobbiamo usare JSON dati da passare nel dispositivo in modo che questo possa essere eseguito solo con l'API.

A volte, è necessaria l'API REST di comunicazione di rete o l'API di trasferimento dello stato rappresentativo.

Come funziona?

All'inizio dobbiamo installare l'app laravel nel nostro sistema in modo da poter seguire la documentazione ufficiale di laravel che ci aiuterà a muoverci ulteriormente. Ecco il link del documento che può essere seguito per installare l'applicazione laravel:

http://laravel.com/

Per installare l'app, usa questo comando ma assicurati di avere il compositore nel tuo sistema, poiché il compositore è uno strumento di dipendenza che aiuta a installare tutte le dipendenze nell'applicazione, puoi seguire questo link:

https://getcomposer.org/download/

Una volta installato il compositore puoi scaricare laravel, per favore usa questo comando:

compositore create-project --prefer-dist laravel/laravel laravel-sanctum-auth

Una volta che il progetto è stato installato, è necessario impostare i dettagli del database nel file .ENV, quindi è sufficiente compilare il database nel file ENV.

Come funziona Il passaggio successivo consiste nell'installare il pacchetto API. Ci sono molti pacchetti disponibili ma puoi installarli secondo la tua scelta.

Quindi per installare il pacchetto, devi seguire il comando come indicato nella documentazione di laravel. Dato che userò Sanctum, userò questo comando:

il compositore richiede laravel/sanctum

  Dopo aver eseguito questo comando, il mio pacchetto verrà installato e sarà pronto per l'uso. Basta seguire lo screenshot qui sotto: Come funziona 2

Una volta terminata la configurazione del pacchetto, il passaggio successivo consiste nel creare il modello per il database. Creeremo una modalità e la migrazione che si collegherà al database diretto,

app/Modelli/file Utente.php.

<?php

spazio dei nomi App\Modelli;

usa Illuminate\Contracts\Auth\MustVerifyEmail;

usa Illuminate\Database\Eloquent\Factories\HasFactory;

usa Illuminate\Foundation\Auth\User come autenticabile;

usa Illuminate\Notifiche\Notificabile;

// santuario

usa Laravel\Sanctum\HasApiTokens;

classe Utente estende Autenticabile

{

utilizzare HasApiTokens, HasFactory, Notificabile;

 

/**

* Gli attributi assegnabili in massa.

*

* @var array

*/

protetto $ compilabile = [

'nome',

'e-mail',

'parola d'ordine',

];

 

/**

* Gli attributi che dovrebbero essere nascosti per gli array.

*

* @var array

*/

protetto $nascosto = [

'parola d'ordine',

'remember_token',

];

 

/**

* Gli attributi da trasmettere ai tipi nativi.

*

* @var array

*/

protetto $cast = [

'email_verified_at' => 'data/ora',

];

}

Come funziona 3

  Ora dobbiamo creare un controller, quindi usa questo comando per creare il controller

Php craft make::controller CONTROLLER NAME

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

<?php



spazio dei nomi App\Http\Controller\API;

usa Illuminate\Http\Richiesta;

usa App\Http\Controllers\Controller come Controller;



classe BaseController estende Controller

{

/**

* metodo di risposta di successo.

*

* @return \Illumina\Http\Risposta

*/

funzione pubblica sendResponse($risultato, $messaggio)

{

$risposta = [

'successo' => vero,

'dati' => $risultato,

'messaggio' => $messaggio,

];

 

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

}



/**

* restituisce una risposta di errore.

*

* @return \Illumina\Http\Risposta

*/

funzione pubblica sendError($error, $errorMessages = [], $codice = 404)

{

$risposta = [

'successo' => falso,

'messaggio' => $ errore,

];

 

if(!vuoto($Messaggi di errore)){

$risposta['dati'] = $Messaggi di errore;

}

 

return response()->json($risposta, $codice);

}

}

Nota: ogni volta che creiamo API, inviamo sempre una risposta in JSON con codice di stato.

Come funziona 4

Per API creiamo sempre token di autenticazione. Significa che se il token verrà creato e verificato, allora possiamo autenticare gli utenti.

<?php

spazio dei nomi App\Http\Controller\API;

usa Illuminate\Http\Richiesta;

usa App\Http\Controllers\API\BaseController come BaseController;

usa Illuminate\Support\Facades\Auth;

utilizzare Validatore;

usa App\Modelli\Utente;

classe AuthController estende BaseController

{

accesso alla funzione pubblica(Richiesta $richiesta)

{

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

$authUser = Auth::user();

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

$success['name'] = $authUser->nome;

return $this->sendResponse($success, 'Utente ha effettuato l'accesso');

}

altro{

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

}

}

iscrizione alla funzione pubblica (Richiesta $ richiesta)

{

$validatore = Validatore::make($richiesta->tutto(), [

'nome' => 'richiesto',

'e-mail' => 'richiesto|e-mail',

'password' => 'richiesto',

'confirm_password' => 'richiesto|stesso:password',

]);

if($validator->fails()){

return $this->sendError('Convalida errore', $validator->errors());

}

$input = $richiesta->tutti();

$input['password'] = bcrypt($input['password']);

$utente = Utente::create($input);

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

$successo['nome'] = $utente->nome;

return $this->sendResponse($success, 'Utente creato con successo.');

}

}

Questo file di percorso:

Come funziona 5 Infine, per eseguire il progetto, dobbiamo eseguire questo comando:

php servizio artigianale

Avvolgendo

Le API alimentano molti dei siti Web e dei servizi più popolari di oggi, dai social network alle app finanziarie. In questo blog, ti è stata presentata l'API REST in Laravel. Ci auguriamo che questo abbia gettato le basi per la tua comprensione di cos'è l'API REST e di come funziona.

Se stai cercando servizi di sviluppo web, non devi cercare oltre. Su webdew potrai trovare un team proattivo di web designer e sviluppatori esperti per progettare e costruire il tuo sito web aziendale. Contattaci per saperne di più.