Cara menulis API menggunakan spesifikasi API RESTful dalam PHP

Dalam pembangunan web, API ialah konsep yang sangat penting. Antaranya, RESTful API telah menjadi salah satu gaya reka bentuk API yang paling popular. API RESTful boleh dianggap sebagai satu set peraturan mudah dan jelas yang boleh membantu pembangun membina perkhidmatan web dengan kebolehskalaan yang baik dan penyelenggaraan yang mudah.

PHP ialah bahasa pengaturcaraan yang digunakan secara meluas untuk pembangunan web, jadi cara menulis API menggunakan spesifikasi API RESTful dalam PHP adalah topik yang sangat penting. Artikel ini akan memperkenalkan cara menulis API menggunakan spesifikasi API RESTful dalam PHP dan menyediakan beberapa amalan dan alatan terbaik.

1. Memahami REST

Adalah sangat penting untuk terlebih dahulu memahami beberapa konsep dan prinsip yang berkaitan dengan REST. REST bermaksud Pemindahan Negeri Perwakilan, yang bermaksud "pemindahan keadaan lapisan pembentangan" dan telah dicadangkan oleh Roy Fielding dalam tesis kedoktorannya pada tahun 2000. Berdasarkan protokol HTTP, REST menyediakan satu set spesifikasi yang menerangkan cara sistem berinteraksi antara pelanggan dan pelayan. Peruntukan ini dipanggil gaya RESTful.

API RESTful adalah berdasarkan prinsip berikut:

• Pemisahan pelanggan-pelayan
• Tanpa Status
• Boleh Cache
• Antara Muka Seragam
• Sistem Berlapis

Berdasarkan pemahaman API RESTful, kami boleh mula melaksanakannya.

2. Menggunakan kata kerja HTTP

RESTful API menggunakan kata kerja dalam protokol HTTP untuk menentukan perkara yang perlu dilakukan oleh pelayan, dan bukannya menggunakan protokol tersuai. Dalam API RESTful, kata kerja HTTP digunakan sebagai kata kunci dalam pengendali aplikasi yang berbeza.

Kata kerja yang biasa digunakan dalam protokol HTTP termasuk:

• DAPAT (dapat sumber)
• POST (cipta sumber)
• PUT (kemas kini sumber )
• DELETE (delete resource)

PHP memperoleh kata kerja HTTP melalui $_SERVER['REQUEST_METHOD'], dan kemudian melakukan operasi yang sepadan mengikut jenis permintaan.

Sebagai contoh, kod berikut menunjukkan cara menggunakan PHP untuk melaksanakan API RESTful asas:

if ($_SERVER['REQUEST_METHOD'] === ' GET ') {
// Laksanakan operasi permintaan GET
} elseif ($_SERVER['REQUEST_METHOD'] === 'POST') {
// Laksanakan operasi permintaan POST
} elseif ($ _SERVER ['REQUEST_METHOD'] === 'PUT') {
// Laksanakan operasi permintaan PUT
} elseif ($_SERVER['REQUEST_METHOD'] === 'DELETE') {
// Laksanakan PADAM Permintaan operasi
} lain {
// Kendalikan permintaan haram
}
?>

Perhatikan bahawa anda boleh menambah kata kerja HTTP lain (seperti PATCH dan HEAD) mengikut keperluan anda.

3. Gunakan URL untuk mengenal pasti sumber

Fokus RESTful API ialah sumber dan sumber boleh dikenal pasti melalui URL. API RESTful yang baik harus mempunyai ciri berikut:

• URL hendaklah dengan jelas mewakili sumber yang hendak diakses.
• URL hendaklah sangat mudah dibaca.
• Kata nama hendaklah digunakan untuk menerangkan sumber.

Sebagai contoh, URL berikut ialah API RESTful untuk mendapatkan semua pengguna:

/users

Di sini, pengguna ialah sumber dan /users ialah yang lengkap URL sumber.

Contoh lain adalah berdasarkan URL di atas, anda boleh menggunakan ID pengguna untuk mengenal pasti pengguna tunggal, seperti berikut:

/users/{id}

di mana { id} ialah pemegang tempat yang boleh digantikan dengan ID pengguna sebenar.

PHP menggunakan pembolehubah $_SERVER['REQUEST_URI'] untuk mendapatkan URL lengkap. Anda boleh menggunakan fungsi explode() untuk memecahkan URL kepada item yang lebih terurus.

4. Kod Status Balasan

Dalam API RESTful, respons kepada permintaan hendaklah sentiasa menyertakan kod status untuk menunjukkan kejayaan atau kegagalan operasi. Berikut ialah beberapa kod status biasa dalam protokol HTTP:

• 200 – OK, menunjukkan bahawa operasi berjaya dan hasilnya dikembalikan.
• 201 – DIBUAT, menunjukkan bahawa sumber telah berjaya dibuat.
• 400 – BAD REQUEST, menunjukkan bahawa permintaan itu tidak sah atau tidak boleh dihuraikan.
• 401 – TANPA KEBENARAN, menunjukkan akses tanpa kebenaran.
• 404 – TIDAK DITEMUI, menunjukkan bahawa sumber yang diminta tidak wujud.
• 500 – RALAT PELAWAT DALAMAN, menunjukkan kegagalan pelayan.

Dalam PHP, anda boleh menggunakan fungsi header() untuk menetapkan kod status respons, contohnya:

http_response_code(200);
? >

5. Format respons

Satu lagi perkara utama RESTful API ialah menentukan format respons. Format respons yang biasa digunakan termasuk JSON dan XML, kedua-duanya sangat mudah dibaca dan digunakan secara meluas pada bahagian hadapan.

Dalam PHP, anda boleh menggunakan fungsi json_encode() untuk menukar data respons kepada format JSON. Kod berikut menunjukkan cara menggunakan ini untuk mengembalikan respons JSON:

$data = array('name' => 'John Doe', 'age' => 20 ) ;

header('Content-Type: application/json');
echo json_encode($data);
?>

6. Gunakan rangka kerja

Apabila melaksanakan RESTful API, menggunakan rangka kerja akan mengurangkan beban kerja semasa proses pembangunan. Terdapat banyak rangka kerja RESTful untuk PHP untuk dipilih, antara yang paling popular termasuk:

• Laravel
• Slim
• Lumen
• Symfony
• Zend

Kebanyakan rangka kerja menyediakan sokongan terbina dalam untuk API RESTful dengan banyak ciri berkuasa seperti penghalaan, pengendalian permintaan, pemformatan respons dan pengesahan data.

7. Melindungi API

Melindungi API ialah bahagian penting dalam reka bentuk API. Dalam PHP, anda boleh menggunakan pelbagai teknik kebenaran untuk melindungi API anda. JWT (Token Web JSON) ialah teknologi kebenaran popular yang menggunakan JSON sebagai format token, yang sangat mudah dibaca dan fleksibel. PHP juga mempunyai perpustakaan yang popular untuk ini - rangka kerja JWT, yang boleh digunakan untuk mencipta dan mengesahkan token JWT.

Kaedah lain yang biasa digunakan ialah menggunakan protokol kebenaran OAuth 2.0, yang mempunyai kerumitan yang lebih tinggi tetapi juga lebih selamat. Apa sahaja teknologi kebenaran yang anda pilih untuk digunakan, anda harus melaksanakan pengesahan dan kebenaran yang betul dalam API anda.

Kesimpulan

Artikel ini memperkenalkan cara menulis API dalam PHP menggunakan spesifikasi API RESTful. Anda harus memahami prinsip dan amalan terbaik API RESTful, termasuk menggunakan kata kerja HTTP, menggunakan URL untuk mengenal pasti sumber, kod status dan format respons, menggunakan rangka kerja dan melindungi API. Dengan mengikuti amalan terbaik ini, anda akan dapat membina API RESTful yang boleh skala dan mudah diselenggara.

Atas ialah kandungan terperinci Cara menulis API menggunakan spesifikasi API RESTful dalam PHP. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!