CodeIgniter 4 REST API Tutorial

(https://www.positronx.io/codeigniter-rest-api-tutorial-with-example/)

Questo è un esempio completo dell'API REST di Codeigniter. In questo tutorial,

impareremo come creare un'API REST usando Codeigniter 4 da zero.
REST definisce un insieme di regole che permette la comunicazione tra più programmi.
Tratteremo le operazioni CRUD utilizzando l'API REST, questo tutorial dà principalmente
la precedenza ai metodi HTTP come GET, PUT, POST, DELETE.

Questo post aiuterà sicuramente tutti gli sviluppatori alle prime armi. Mi assicurerò che tu
debba essere a conoscenza di tutti i metodi che sono essenziali per sapere come creare
servizi Web REST in Codeigniter.

Creerò un'app CI (Code Igniter), mi collegherò al database e aggiungerò, aggiornerò,

eliminerò e mostrerò i dati interagendo con il database MySQL. Daremo anche un'occhiata
a Postman per testare l'API REST.

Sommario

1) Installare l'applicazione Codeigniter 4

2) Attivare Segnalazione errori
3) Creare database e tabelle
4) Mettere insieme i dettagli del database
5) Creare il Model
6) Creare il Controller REST
7) Creare routes API REST
8) Testare le API REST Codeigniter

Installare l'applicazione Codeigniter 4

Il primo passaggio inizia con l'installazione dell'applicazione CodeIgniter 4. Questa

configurazione richiede l'installazione di Composer Package Manager nel computer di
sviluppo.

composer create-project codeigniter4/appstarter

Dopo l'installazione, rinomina la cartella appstarter, ad esempio in codeigniter-rest-api.

Quindi, vai alla cartella del progetto:

cd codeigniter-rest-api

Puoi saltare il processo sopra e scaricare direttamente l'applicazione Codeigniter ed

eliminare il processo di cui sopra.

1
Attivare Segnalazione Errori

La segnalazione degli errori è necessaria per lo sviluppo dell'applicazione e rende lo

sviluppo dell'app più accessibile. Che si sia principianti o sviluppatori esperti, si
commettono errori accidentali o inconsapevoli durante lo sviluppo.

La segnalazione degli errori ci aiuta a correggere gli errori in tempo reale e ci aiuta anche
a controllare il codice con facilità.

Vai su app/Config/Boot/development.php e modifica il valore display_errors a 1

anziché a 0.

Apporta esattamente le stesse modifiche nel file app/Config/Boot/production.php.

ini_set('display_errors', '1');

Creare database e tabelle

Conserveremo e gestiremo i dati nel database; questo è ciò che l'API REST ha deciso di
fare. Apri PHPMyAdmin e crea un nuovo database.

CREATE DATABASE demo;

All'interno del database demo, crea una nuova tabella employess in cui tutti i valori
verranno archiviati utilizzando l'API RESTful.

CREATE TABLE employees (

id int(11) NOT NULL AUTO_INCREMENT COMMENT 'Primary Key',
name varchar(100) NOT NULL COMMENT 'Name',
email varchar(255) NOT NULL COMMENT 'Email Address',
PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='datatable demo
table' AUTO_INCREMENT=1;

CREATE UNIQUE INDEX employees_email_IDX USING BTREE ON

demo.employees (email);

INSERT INTO `employees` (`id`, `name`, `email`) VALUES

(1, 'John Doe', '[email protected]'),
(2, 'Vanya Hargreeves', '[email protected]'),
(3, 'Luther Hargreeves', '[email protected]'),
(4, 'Diego Hargreeves', '[email protected]'),
(5, 'Klaus Hargreeves', '[email protected]'),
(6, 'Ben Hargreeves', '[email protected]'),
(7, 'The Handler', '[email protected]');

2
Mettere insieme i dettagli del database

Se non sai come connettere codeigniter al database MySQL. Quindi, aggiungi i dettagli del
database come nome, username e password nel file app/Config/Database.php.

public $default = [
'DSN' => '',
'hostname' => 'localhost',
'username' => 'root',
'password' => 'root',
'database' => 'demo',
'DBDriver' => 'MySQLi',
'DBPrefix' => '',
'pConnect' => false,
'DBDebug' => (ENVIRONMENT !== 'production'),
'charset' => 'utf8',
'DBCollat' => 'utf8_general_ci',
'swapPre' => '',
'encrypt' => false,
'compress' => false,
'strictOn' => false,
'failover' => [],
'port' => 3306,
];

CodeIgniter\Database\Exceptions\DatabaseException #8 Impossibile connettere il

database: Codeigniter

Se in qualsiasi modo ottieni l'errore Codeigniter: impossibile connettersi al database

MySQL, modifica il valore del nome host in base al tuo server locale, ad esempio MAMPP
o XAMPP.

# MAMPP
public $default = [
...
'hostname' => '/Applications/MAMP/tmp/mysql/mysql.sock',
...
]

# XAMPP
public $default = [
...
'hostname' =>
'/Applications/XAMPP/xamppfiles/var/mysql/mysql.sock',
...
]

3
Creare il Model

Crea un file Model EmployeeModel.php all'interno della directory app/Models/. Inserire il

codice seguente all'interno del file per definire il Model.

<?php

namespace App\Model;
use CodeIgniter\Model;

class EmployeeModel extends Model

{
protected $table = 'employees';
protected $primaryKey = 'id';
protected $allowedFields = ['name','email'];
}

Creare il Controller REST

Crea un controller Employee.php nella cartella app/Controllers/. In questo file creeremo

le funzioni che gestiranno le operazioni di creazione, lettura, aggiornamento e
cancellazione.

<?php
namespace App\Controllers;
use CodeIgniter\RESTful\ResourceController;
use CodeIgniter\API\ResponseTrait;
use App\Model\EmployeeModel;

class Employee extends ResourceController

{
use ResponseTrait;

// all users
public function index() {...}

// create
public function create() {...}

// single user
public function show($id = null) {...}

4
 // update
public function update($id = null) {...}

// delete
public function delete($id = null) {...}
}

I metodi seguenti si occupano di un'attività particolare con l'API RESTful, consentitemi di

enumerare tutte le funzioni eseguite da ciascun metodo che abbiamo definito nel
controller.
 index() - Ottieni tutti i record dal database.
 create() - Spinge un record di un dipendente nella tabella del database.
 show() - Ottiene un record di un singolo dipendente dal database.
 update() - Aggiorna il record dell'utente nel database.
 delete() - Elimina un record dipendente dal database.

Creare routes API REST

Per sostenere lo slancio dei dati tra client e server abbiamo bisogno di API, per accedere
alle API dobbiamo anche definire il percorso in CI (Code Igniter).

Apri il file app/Config/Routes.php e cerca il codice seguente.

$routes->get('/', 'home::index');

Quindi, rimuovi la riga di codice sopra e aggiungi la riga di codice specificata.

$routes->resource('employee');

Testare le API REST Codeigniter

Alla fine, abbiamo superato ogni imperativo. Ora è il momento di avviare l'applicazione
usando il seguente comando:

php spark serve

testiamo l'API REST che ottiene tutti i record utente dal database.

vediamo le chiamate e cosa fanno

recuperiamo tutti gli impiegati

- http://localhost:8080/employee (GET)

recuperiamo un singolo impiegato

5
 - http://localhost:8080/employee/4 (GET)

aggiorna un singolo impiegato

- http://localhost:8080/employee/4 (PUT)

aggiungere un impiegato nel database

- http://localhost:8080/employee (POST)

eliminare un impiegato dal database

- http://localhost:8080/employee/13 (DELETE)