Download PHP REST Api - Unduh Kode Sumber PHP REST Api

Istirahat-API

Ini adalah PHP REST-API menggunakan otentikasi HTTP dasar. Karena otentikasi HTTP dasar dikodekan tetapi tidak dienkripsi, sangat disarankan untuk menggunakan koneksi aman (https) dan kata sandi yang kuat.

Jika Anda menggunakan API ini untuk menangani data sensitif, Anda melakukannya dengan risiko sendiri.

Daftar isi

Konfigurasi
- Siapkan database MySQL
- Luncurkan PHP Build in WebServer
- Otentikasi
- Tetapkan kredensial
Buat Layanan
Cara menggunakan API
- Dapatkan koleksi
- Dapatkan satu item
- Buat item baru
- Perbarui item
- Hapus item
Penggunaan yang diperpanjang
- Melakukan tugas khusus
Kode Status HTTP
Menambahkan middleware
Pengarang
Lisensi

Konfigurasi

Siapkan database MySQL

Siapkan server MySQL dan jalankan example_database.sql . Masukkan parameter MySQL terkait di settings.php .

Luncurkan PHP Build in WebServer

 $ php -S localhost:2400 -t public

Otentikasi

Otentikasi diaktifkan secara default. Anda dapat menonaktifkannya di settings.php .

Tetapkan kredensial

Kredensial di bawah ini saat ini dikodekan dengan keras di middleware lib/Authentication . Terserah Anda untuk menerapkan logika yang tepat.

 $ username = " rest " ;
$ password = " test " ;

Buat Layanan

Anda membuat layanan di direktori services dan folder versi tertentu. Layanan selalu mewarisi dari layanan web kelas abstrak. Berikut adalah templat dasar yang dapat Anda gunakan untuk memulai dengan cepat:

 use RESTapi  Sources  Request ;
use RESTapi  Sources  Response ;
use RESTapi  Sources  WebService ;
use RESTapi  Library  Database ;

class YourService extends WebService {

    private Database | null $ db ;

    public function __construct ()
    {
        $ this -> db = Database:: getInstance ();
    }

    public function get ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 12 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Data-Count " , $ affectedRows );
        $ response -> setStatus ( 200 );
    }

    public function post ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 12 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Insert-Count " , $ affectedRows );
        $ response -> setStatus ( 201 );
    }

    public function put ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 1 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Update-Count " , $ affectedRows );
        $ response -> setStatus ( 204 );
    }

    public function delete ( Request $ request , Response $ response ): void 
    {
        // Your logic here ...
        $ affectedRows = 1 ;
        $ response -> write ( " JSON " ); // Add a JSON object
        $ response -> addHeader ( " X-Delete-Count " , $ affectedRows );
        $ response -> setStatus ( 205 );
    }
}

Bekerja dengan database:
Silakan periksa layanan Users untuk mempelajari dan memahami cara membuat kueri untuk melakukan operasi CRUD.

Cara menggunakan API

Dapatkan koleksi

Penggunaan: GET domain.tld/[version]/[service]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/ " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Dapatkan satu item

Penggunaan: GET domain.tld/[version]/[service]/[id]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/3 " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Buat item baru

Penggunaan: POST domain.tld/[version]/[service]

 $ body = [
    " name " => " Greta Garbo " ,
    " age " => " 93 " ,
    " city " => " Hollywood " ,
    " country " => " California "
];
$ ch = curl_init ( " http://localhost:2400/v1/Users " );
curl_setopt ( $ ch , CURLOPT_POST , true );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Perbarui item

Penggunaan: PUT domain.tld/[version]/[service]/[id]

 $ body = [
    " name " => " John Rambo " ,
    " age " => " 42 " ,
    " city " => " Seattle " ,
    " country " => " Washington "
];
$ ch = curl_init ( " http://localhost:2400/v1/Users/4 " );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " PUT " );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Hapus item

Penggunaan: DELETE domain.tld/[version]/[service]/[id]

 $ ch = curl_init ( " http://localhost:2400/v1/Users/1 " );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " DELETE " );
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Penggunaan yang diperpanjang

Melakukan tugas khusus

Layanan mewarisi empat fungsi get , post , put , dan delete dari kelas layanan web abstrak secara default. Itu sempurna untuk melakukan tindakan kasar pada database. Tetapi bagaimana jika Anda membutuhkan layanan yang harus melakukan beberapa tugas khusus? Dalam kasus seperti itu Anda dapat menggunakan PATCH metode permintaan HTTP dan memberikan nama tindakan di URI.

Di bawah ini adalah contoh layanan kalukulasi yang melipatgandakan dua angka:

Penggunaan: PATCH domain.tld/[version]/[service]/[action]

 $ ch = curl_init ( " http://localhost:2400/v1/Calculator/multiply " );
$ body = [
    " a " => 12 ,
    " b " => 2.5
];
$ ch = curl_init ( $ url );
curl_setopt ( $ ch , CURLOPT_CUSTOMREQUEST , " PATCH " );
curl_setopt ( $ ch , CURLOPT_POSTFIELDS , http_build_query ( $ body ));
curl_setopt ( $ ch , CURLOPT_HTTPAUTH , CURLAUTH_BASIC );
curl_setopt ( $ ch , CURLOPT_USERPWD , " $ username : $ password " );
curl_setopt ( $ ch , CURLOPT_HEADER , true );

if (! $ output = curl_exec ( $ ch )) {
    trigger_error ( curl_error ( $ ch ));
}

curl_close ( $ ch );

Kode Status HTTP

API menanggapi dengan kode status berikut. Anda dapat mengubah ini sesuai dengan keinginan Anda:

Tentang kesuksesan:

Dapatkan: 200 Ok
Posting: 201 dibuat
Put: 204 Tidak Ada Konten atau 202 Diterima
Hapus: 205 Reset Konten

Jika tidak:

400 permintaan buruk
401 tidak sah
404 tidak ditemukan
500 kesalahan server internal

Menambahkan middleware

Di bawah ini adalah pola contoh yang dapat Anda gunakan untuk membangun middleware Anda sendiri. Anda dapat membuat middleware Anda sendiri dengan membuat kelas di folder lib yang mengimplementasikan antarmuka Imiddleware :

 class YourMiddleware implements IMiddleware {

    public function handle ( Request $ request , Response $ response ): void {}
}

Untuk menyuntikkan middleware ke middleware lain, gunakan konstruktor middleware itu:

 class YourMiddleware implements IMiddleware {

    public function __construct ( private IMiddleware $ anotherMiddleware ) {}

    public function handle ( Request $ request , Response $ response ): void
    {
        // 1. Add your logic ...

        // 2. Handle Middleware ...
        $ this -> anotherMiddleware -> handle ( $ request , $ response );

        // 3. Do something afterwards ...
    }
}

$ anotherMiddleware = new AnotherMiddleware ();
$ yourMiddleware = new YourMiddleware ( $ anotherMiddleware );
$ yourMiddleware -> handle ( $ request , $ response );