PHP REST Api

REST-API

هذا هو PHP REST-API باستخدام مصادقة HTTP الأساسية. نظرًا لأن مصادقة HTTP الأساسية مشفرة ولكن غير مشفرة ، فمن المستحسن بشدة استخدام اتصال آمن (HTTPs) وكلمة مرور قوية.

إذا كنت تستخدم واجهة برمجة التطبيقات هذه للتعامل مع البيانات الحساسة ، فأنت تفعل ذلك على مسؤوليتك الخاصة.

جدول المحتويات

1. إعدادات
   • قم بإعداد قاعدة بيانات MySQL
   • إطلاق PHP Build في خادم الويب
   • المصادقة
   • تعيين بيانات الاعتماد
2. إنشاء خدمة
3. كيفية استخدام API
   • احصل على مجموعة
   • احصل على عنصر واحد
   • إنشاء عنصر جديد
   • تحديث عنصر
   • حذف عنصر
4. الاستخدام الممتد
   • أداء المهام الخاصة
5. رموز حالة HTTP
6. إضافة الوسيطة
7. مؤلف
8. رخصة

إعدادات

قم بإعداد قاعدة بيانات MySQL

قم بإعداد خادم MySQL وتنفيذ example_database.sql . أدخل معلمات MySQL ذات الصلة في settings.php .

إطلاق PHP Build في خادم الويب

 $ php -S localhost:2400 -t public

المصادقة

يتم تمكين المصادقة افتراضيا. يمكنك تعطيله في settings.php .

تعيين بيانات الاعتماد

يتم ترميز بيانات الاعتماد أدناه حاليًا في البرامج الوسيطة lib/Authentication . الأمر متروك لك لتنفيذ منطق مناسب.

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

إنشاء خدمة

يمكنك إنشاء خدمات في دليل services ومجلد الإصدار المحدد. خدمة ترث دائمًا من خدمة WebService المجردة. فيما يلي قالب أساسي يمكنك استخدامه للبدء بسرعة:

 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 );
    }
}

العمل مع قاعدة البيانات:
يرجى الخروج من خدمة Users لتعلم وفهم كيفية إنشاء استفسارات لأداء عمليات CRUD.

كيفية استخدام API

احصل على مجموعة

الاستخدام: 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 );

احصل على عنصر واحد

الاستخدام: 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 );

إنشاء عنصر جديد

الاستخدام: 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 );

تحديث عنصر

الاستخدام: 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 );

حذف عنصر

الاستخدام: 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 );

الاستخدام الممتد

أداء المهام الخاصة

ترث الخدمة أربع وظائف get post put delete من فئة خدمة الويب المجردة افتراضيًا. هذه مثالية لأداء إجراءات CRUD على قاعدة بيانات. ولكن ماذا لو كنت بحاجة إلى خدمة يجب أن تفعل بعض المهام الخاصة؟ في مثل هذه الحالة ، يمكنك استخدام PATCH طريقة طلب HTTP وتقديم اسم الإجراء في URI.

فيما يلي مثال على خدمة caruculation التي تضاعف رقمين:

الاستخدام: 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 );

رموز حالة HTTP

يستجيب API مع رموز الحالة التالية. يمكنك تغيير هذا إلى رغبتك:

على النجاح:

• الحصول على: 200 موافق
• المنشور: 201 تم إنشاؤه
• وضع: 204 لا محتوى أو 202 مقبولة
• حذف: 205 إعادة تعيين المحتوى

خلاف ذلك:

• 400 طلب سيء
• 401 غير مصرح به
• 404 لم يتم العثور عليها
• 500 خطأ خادم داخلي

إضافة الوسيطة

فيما يلي نمط مثال يمكنك استخدامه لبناء البرامج الوسيطة الخاصة بك. يمكنك إنشاء البرامج الوسيطة الخاصة بك عن طريق إنشاء فئة في مجلد lib الذي ينفذ واجهة imiddleware :

 class YourMiddleware implements IMiddleware {

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

لحقن البرامج الوسيطة في برامج وسيطة أخرى ، استخدم مُنشئ هذا الوسيطة:

 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 );

مؤلف

مارتن وولف

رخصة

معهد ماساتشوستس للتكنولوجيا