REST API dan Seni Binanya

Pengenalan

Dalam dunia pembangunan web hari ini, API (Antara Muka Pengaturcaraan Aplikasi) memainkan peranan penting dalam membolehkan komunikasi antara sistem perisian yang berbeza. Salah satu jenis API yang paling banyak digunakan ialah API REST, yang bermaksud Pemindahan Negeri Perwakilan. API REST telah menjadi standard untuk membina perkhidmatan web yang boleh skala, boleh diselenggara dan cekap. Dalam blog ini, kami akan menyelami lebih mendalam tentang apa itu REST API, prinsip, seni bina, komponen dan cara mereka bentuk serta melaksanakannya dengan berkesan.

Apakah itu REST API?
REST (Pemindahan Negeri Perwakilan) ialah gaya seni bina untuk mereka bentuk aplikasi rangkaian. Ia bergantung pada model komunikasi pelanggan-pelayan tanpa kewarganegaraan dan berdasarkan kaedah HTTP standard. API REST membenarkan aplikasi yang berbeza untuk berkomunikasi melalui internet menggunakan set konvensyen ringkas atau kita boleh katakan peraturan.

API REST ialah antara muka yang membolehkan pelanggan (seperti web atau aplikasi mudah alih seperti penyemak imbas atau telefon kami) berinteraksi dengan pelayan dengan menghantar permintaan HTTP dan menerima respons HTTP. Pelayan menyediakan akses kepada sumber, yang boleh berupa apa sahaja daripada profil pengguna kepada imej atau catatan blog.
Prinsip Utama REHAT
Untuk dianggap RESTful, API mesti mempunyai enam prinsip berikut:

1. Seni Bina Pelayan-Pelanggan: Pelanggan dan pelayan hendaklah bebas antara satu sama lain. Pelanggan bertanggungjawab untuk antara muka pengguna dan pengalaman pengguna, manakala pelayan mengendalikan logik bahagian belakang, storan data dan pemprosesan.
2. Ketiadaan kenegaraan: Setiap permintaan daripada pelanggan kepada pelayan mesti mengandungi semua maklumat yang diperlukan untuk memahami dan memproses permintaan tersebut. Pelayan tidak menyimpan sebarang maklumat pelanggan antara permintaan. Ini menjadikan reka bentuk pelayan dan meningkatkan kebolehskalaan.
3. Kebolehcache: Respons daripada pelayan mesti ditakrifkan dengan jelas sebagai boleh cache atau tidak boleh cache. Jika respons boleh dicache, pelanggan boleh menggunakan semula data respons untuk permintaan masa hadapan, mengurangkan beban pada pelayan dan meningkatkan prestasi.
4. Antara Muka Seragam: REST API mesti menyediakan cara yang konsisten dan standard untuk berinteraksi dengan sumber. Ini dicapai melalui empat sub-prinsip:  - Pengenalpastian Sumber: Sumber dikenal pasti menggunakan URI (Uniform Resource Identifiers).  - Manipulasi Sumber Melalui Perwakilan: Pelanggan berinteraksi dengan sumber dengan menghantar perwakilan (cth., JSON, XML) dalam permintaan.  - Mesej deskriptif kendiri: Setiap permintaan dan respons mesti mengandungi maklumat yang mencukupi untuk menerangkan cara memproses mesej.  - Hypermedia sebagai Enjin Keadaan Aplikasi (HATEOAS): Pelanggan harus menavigasi API secara dinamik menggunakan hiperpautan yang disediakan dalam respons.
5. Sistem Berlapis: Seni bina harus membenarkan penggunaan lapisan perantara antara klien dan pelayan, seperti caching, pengimbangan beban dan lapisan keselamatan, tanpa pelanggan menyedari lapisan ini.
6. Kod atas Permintaan (Pilihan): Pelayan boleh melanjutkan fungsi klien dengan menghantar kod boleh laku, seperti JavaScript, untuk dilaksanakan pada bahagian klien. Ini adalah kekangan pilihan dalam REST.

Seni Bina REST API
Seni bina API REST terdiri daripada beberapa komponen utama yang bekerjasama untuk mewujudkan komunikasi antara pelanggan dan pelayan:

1. Sumber: Sumber ialah konsep teras API REST. Ia mewakili data atau objek yang API menyediakan akses, seperti pengguna, produk, pesanan, dll. Setiap sumber dikenal pasti oleh URI unik.

2. Kaedah HTTP: REST API menggunakan kaedah HTTP standard untuk melaksanakan operasi CRUD (Buat, Baca, Kemas Kini, Padam) pada sumber:
    - DAPATKAN: Tarik data daripada sumber.
    - POST: Buat perubahan data baharu dalam sumber(DB).
    - PUT: Kemas kini rekod sedia ada dalam data(DB) anda.
    - PADAM: Alih keluar data khusus daripada DB.
    - PATCH: Kemas kini sebahagian data sedia ada.
    - PILIHAN: Dapatkan semula kaedah HTTP yang disokong untuk sumber.

3. Kod Status HTTP: REST API menggunakan kod status HTTP standard untuk menunjukkan hasil permintaan. Kod status biasa termasuk:
    - 200 OK: Permintaan berjaya.
    - 201 Dicipta: Sumber baharu telah berjaya dibuat.
    - 204 Tiada Kandungan: Permintaan berjaya, tetapi tiada kandungan untuk dikembalikan.
    - 400 Permintaan Buruk: Permintaan itu salah bentuk atau tidak sah.
    - 401 Tanpa Kebenaran: Pelanggan mesti mengesahkan untuk mengakses sumber.
    - 404 Tidak Ditemui: Sumber yang diminta tidak ditemui.
    - 500 Ralat Pelayan Dalaman: Ralat yang tidak dijangka berlaku pada pelayan.

4. Format Perwakilan: REST API menyokong pelbagai format perwakilan untuk pertukaran data, termasuk JSON (JavaScript Object Notation), XML (eXtensible Markup Language) dan HTML. JSON ialah format yang paling biasa digunakan kerana kesederhanaan dan keserasiannya dengan JavaScript.

5. Titik Tamat: Titik akhir ialah URL yang menentukan tempat sumber tertentu boleh diakses daripada pelayan. Setiap titik akhir sepadan dengan sumber tertentu dan biasanya direka bentuk menggunakan kata nama dan bukannya kata kerja (cth., /users, /products).

Merancang API RESTful

Merancang API RESTful melibatkan beberapa langkah untuk memastikan ia mematuhi prinsip REST dan memberikan pengalaman yang lancar untuk pelanggan. Berikut ialah beberapa amalan terbaik untuk mereka bentuk API REST:

1. Gunakan Kata Nama untuk Titik Akhir: Titik tamat hendaklah dinamakan sempena sumber (kata nama) dan bukannya tindakan (kata kerja). Contohnya, gunakan /users untuk mewakili koleksi pengguna dan bukannya /getUsers.

2. Gunakan Kaedah HTTP Sewajarnya: Gunakan kaedah HTTP yang betul untuk setiap operasi. Contohnya, gunakan GET untuk mendapatkan data, POST untuk membuat data, PUT untuk mengemas kini data dan PADAM untuk mengalih keluar data.

3. Laksanakan Penapisan, Pengisihan dan Penomboran: Untuk titik akhir yang mengembalikan senarai sumber, laksanakan penapisan, pengisihan dan penomboran untuk meningkatkan prestasi dan memberikan lebih kawalan kepada pelanggan. Gunakan parameter pertanyaan seperti ?sort=name, ?page=2, atau ?limit=10 untuk mencapai ini.

4. Versi API Anda: Sentiasa versikan API anda untuk mengendalikan perubahan tanpa melanggar pelanggan sedia ada. Sertakan nombor versi dalam URL (cth., /api/v1/users) atau dalam pengepala.

5. Sediakan Kod Status HTTP Bermakna: Kembalikan kod status HTTP yang sesuai untuk menunjukkan hasil permintaan. Elakkan menggunakan 200 OK untuk setiap respons.

6. Gunakan Hipermedia (HATEOAS): Sertakan pautan dalam respons untuk membolehkan pelanggan menavigasi API secara dinamik tanpa URL pengekodan keras.

7. Pastikan Keselamatan: Lindungi API anda menggunakan HTTPS untuk menyulitkan data dalam transit. Laksanakan pengesahan (cth., OAuth, JWT) dan Kebenaran untuk mengawal akses kepada sumber.

8. Kendalikan Ralat Dengan Anggun: Sediakan mesej ralat yang bermakna dan kod status HTTP untuk membantu pelanggan memahami masalah yang berlaku. Buat format ralat boleh guna semula dengan butiran seperti kod ralat, mesej dan penyelesaian yang mungkin.

Contoh Reka Bentuk API REST

Mari kita pertimbangkan contoh REST API mudah untuk menguruskan koleksi buku:

1. Titik tamat: /api/v1/books
2. DAPATKAN /api/v1/books: Dapatkan senarai semua buku daripada db.  - POST /api/v1/books: Buat buku baharu dalam db.
3. Titik tamat: /api/v1/books/{id}
4. DAPATKAN /api/v1/books/{id}: Kembalikan buku tertentu mengikut ID.  - PUT /api/v1/books/{id}: Kemas kini buku tertentu mengikut ID.  - DELETE /api/v1/books/{id}: Padamkan buku tertentu dengan ID.
5. Contoh Pengendalian Ralat:
6. Jika pelanggan meminta buku yang tidak wujud:   - Maklum balas: 404 Tidak Ditemui   - Badan: Badan akan kelihatan seperti ini

Melaksanakan API REST

Untuk melaksanakan API REST, anda boleh menggunakan pelbagai bahasa pengaturcaraan dan rangka kerja. Berikut ialah contoh menggunakan Node.js dengan Express.js:

Atas ialah kandungan terperinci REST API dan Seni Binanya. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!