API REST: Read e Create

Nel codice sopra riportato, quello che facciamo per prima cosa è importare i file database.php e libro.php. Questi ci serviranno per poter creare gli oggetti Database e Libro. Inizializzeremo l'oggetto Libro con l'oggetto db, di tipo Database, per poter accedere al database della nostra Biblioteca.

Con l'oggetto $libro siamo in grado di richiamare il suo metodo read() che si occupa di collegarsi al database della Biblioteca e di eseguire una query SELECT su di esso. Quello che facciamo successivamente è verificare che il risultato del metodo read() abbia ricevuto dei risultati (ovvero che dei libri siano stati effettivamente restituiti dalla query SQL). Se dei record sono presenti, allora saranno inseriti in un array PHP chiamato $libri_arr e ritornati in formato JSON grazie alla conversione data dalla funzione json_encode(), insieme alla risposta di successo con codice 200 HTTP. In assenza di libri nel database, un messaggio "Nessun libro trovato in Biblioteca" verrà inserito nell'array e una risposta HTTP con codice 404 restituita all'utente.

Per poter testare questa prima API, possiamo servirci del noto plugin Postman per il browser Chrome o del plugin fratello, RESTClient di Firefox.
Dopo ovviamente aver avviato il server Apache con PHP, dovremo semplicemente inserire l'URL seguente nell'interfaccia di uno dei due plugin, in modo da simulare una richiesta REST:

http://localhost/BibliotecaREST/libro/read.php

A questo punto, ci verrà mostrata la lista dei libri (in formato JSON) appartenenti alla Biblioteca.

Create.php

Occupiamoci adesso di scrivere il file create.php nella stessa directory in cui abbiamo creato file read.php.

<?php
//headers
header("Access-Control-Allow-Origin: *");
header("Content-Type: application/json; charset=UTF-8");
header("Access-Control-Allow-Methods: POST");
header("Access-Control-Max-Age: 3600");
header("Access-Control-Allow-Headers: Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With");
 
include_once '../config/database.php';
include_once '../models/libro.php';
 
$database = new Database();
$db = $database->getConnection();
$libro = new Libro($db);
$data = json_decode(file_get_contents("php://input"));
if(
    !empty($data->ISBN) &&
    !empty($data->Titolo) &&
    !empty($data->Autore)
){
    $libro->ISBN = $data->ISBN;
    $libro->Titolo = $data->Titolo;
    $libro->Autore = $data->Autore;
 
    if($libro->create()){
        http_response_code(201);
        echo json_encode(array("message" => "Libro creato correttamente."));
    }
    else{
        //503 servizio non disponibile
        http_response_code(503);
        echo json_encode(array("message" => "Impossibile creare il libro."));
    }
}
else{
    //400 bad request
    http_response_code(400);
    echo json_encode(array("message" => "Impossibile creare il libro i dati sono incompleti."));
}
?>

La richiesta per la creazione di un nuovo Libro nella Biblioteca è un po' più elaborata rispetto a quella precedente. Come vediamo all'inizio del codice sopra riportato, per prima cosa dobbiamo creare l'header di richiesta HTTP. Notiamo che per questa richiesta specifichiamo come metodo HTTP quello POST, cosa che non abbiamo fatto nel codice del file read.php. Infatti, se riprendiamo la tabella all'inizio di questa lezione, vediamo che la richiesta di lettura dati necessita del metodo HTTP GET e che quella di creazione del metodo POST. In read.php non abbiamo avuto la necessità di specificare il tipo di metodo HTTP perchè una richiesta HTTP è già di default considerata come GET.

Specificato ciò, le funzioni di questo codice che meritano di essere maggiormente attenzionate sono la json_decode e la file_get_contents.
La prima, come si intuisce dal nome, riceve una stringa codificata in formato JSON e la converte in una variabile PHP; la seconda, invece, permette di recuperare il contenuto da file locali o URL tradizionali e memorizzarli in una stringa. Quindi, entrambe queste funzioni leggono dati JSON e li salvano in una variabile PHP.

L'uso del metodo HTTP POST, nel caso del'API create.php non è casuale. Una richiesta POST viene infatti utilizzata quando si ha la necessità di inviare al server alcune informazioni aggiuntive all'interno del suo body.
Le informazioni aggiuntive da inviare al nostro server saranno, ovviamente, i dati del libro che vorremmo inserire.

Il codice esegue infine dei controlli su i dati immessi nel body della richiesta, controllando se sono completi o se non è possibile inserirli nel database (magari perchè un duplicato è già presente).

Per testare il codice, utilizziamo nuovamente Postman. In ordine, dovremo:

1. impostare il metodo HTTP POST
2. immettere l'URL della richiesta
3. selezionare il body per immettere i dati del libro
4. selezionare raw
5. inserire il JSON seguente:

   {
       "ISBN" : "00000020dd02",
       "Titolo" : "Kafka sulla spiaggia",
       "Autore" : "Murakami Haruki",
   }





Se tutto è andato per il meglio, verrà mostrato un messaggio di buona riuscita con codice 200.

Nella prossima lezione tratteremo le richieste update e delete.

Se vuoi aggiornamenti su su questo argomento inserisci la tua email nel box qui sotto:

Iscriviti

Sì

No

Acconsento alla ricezione di comunicazioni promozionali da parte del Titolare, relative a prodotti e servizi di terzi.

Compilando il presente form acconsento a ricevere le informazioni relative ai servizi di cui alla presente pagina ai sensi dell'informativa sulla privacy.