Dapatkan API REST palsu dan berjalan menggunakan pelayan JSON

Dalam tutorial ini, anda akan melihat bagaimana untuk memulakan dengan menubuhkan dan menggunakan pelayan API REST palsu menggunakan JSON-SERVER, yang boleh anda gunakan semasa membangunkan aplikasi mudah alih atau web. Tutorial ini menganggap bahawa anda mempunyai pengetahuan asas mengenai permintaan JSON dan HTTP.

Apa itu rehat?

REST bermaksud pemindahan negara perwakilan. Ia adalah gaya seni bina untuk mereka bentuk aplikasi yang bersambung. Ia menggunakan HTTP mudah untuk membuat komunikasi antara mesin mungkin. Oleh itu, bukannya menggunakan URL untuk memanipulasi beberapa maklumat pengguna, REST menghantar permintaan HTTP seperti GET, POST, DELETE, dan lain -lain ke URL untuk memanipulasi data.

Sebagai contoh, bukannya membuat permintaan untuk URL seperti /deleteuser?id=10 , permintaan itu akan seperti DELETE /user/10 .

Mengapa kita memerlukan API REST palsu?

Rehat API membentuk hujung belakang untuk aplikasi mudah alih dan web. Apabila membangunkan aplikasi, kadang -kadang anda tidak akan mempunyai API lain yang bersedia untuk digunakan untuk tujuan pembangunan. Untuk melihat aplikasi mudah alih atau web dalam tindakan, kami memerlukan pelayan yang melemparkan beberapa data JSON dummy.

Ketika itulah API REST palsu masuk ke dalam gambar. json-server menyediakan fungsi untuk menubuhkan pelayan API REST palsu dengan usaha minimum.

Bermula

Untuk memulakan dengan menggunakan json-server , pasangkan pakej menggunakan Pengurus Pakej Node (NPM).

 Pemasangan NPM -G JSON -SERVER<br>

Buat fail JSON Dummy dengan beberapa data mengikut keperluan anda. Sebagai contoh, saya memerlukan beberapa data JSON dengan maklumat pengguna seperti ID, nama, lokasi, dan lain -lain. Oleh itu, saya akan membuat fail yang dipanggil info.json dengan maklumat JSON berikut:

 {<br> "Pengguna": [{<br> "Id": 1,<br> "Nama": "Roy",<br> "Lokasi": "India"<br> }, {<br> "Id": 2,<br> "Nama": "Sam",<br> "Lokasi": "Wales"<br> }]<br> }<br>

Dari terminal, jalankan pelayan JSON dengan info.json sebagai sumber data, dan anda harus mempunyai API REST yang berjalan di http: // localhost: 3000.

 JSON-SERVER INFO.JSON<br>

Menguji titik akhir API REST

Oleh kerana pelayan API REST palsu kami berjalan dan berjalan, mari kita lihat bagaimana untuk mengakses API REST menggunakan klien. Saya menggunakan pelanggan Rest Postman untuk membuat panggilan API.

Dapatkan permintaan

Mari kita mulakan dengan membuat permintaan GET url yang lain. Di dalam fail JSON, kami telah menentukan users titik akhir yang mengandungi maklumat yang berkaitan dengan pengguna. Apabila membuat permintaan GET ke URL http: // localhost: 3000/pengguna, ia harus memaparkan data sedia ada.

Permintaan pos

Untuk menambah data baru ke data yang sedia ada, kami akan membuat permintaan POST ke URL http: // localhost: 3000/pengguna. Inilah permintaan POST yang akan kelihatan seperti:

Cuba lakukan permintaan GET , dan anda harus mempunyai data yang baru ditambah dalam fail info.json .

 [<br> {<br> "Id": 1,<br> "Nama": "Roy",<br> "Lokasi": "India"<br> },<br> {<br> "Id": 2,<br> "Nama": "Sam",<br> "Lokasi": "Wales"<br> },<br> {<br> "Nama": "II",<br> "Lokasi": "la",<br> "Id": 7<br> },<br> {<br> "Nama": "Shona",<br> "Lokasi": "la",<br> "Id": 8<br> },<br> {<br> "Nama": "Shona",<br> "Lokasi": "la",<br> "Id": 9<br> }<br> ]<br>

Padam permintaan

Untuk memadam entri dari data json-server , anda perlu menghantar permintaan DELETE ke titik akhir API dengan ID Pengguna. Sebagai contoh, untuk memadam pengguna dengan ID 1, anda perlu menghantar permintaan DELETE ke titik akhir http: // localhost: 3000/pengguna/1. Sebaik sahaja ia dipadamkan, cuba lakukan permintaan GET , dan pengguna dengan ID 1 tidak boleh berada di JSON yang dikembalikan.

Permintaan patch

Untuk mengemas kini entri yang sedia ada, anda perlu menghantar permintaan PATCH dengan butiran yang perlu dikemas kini untuk entri tertentu. Sebagai contoh, untuk mengemas kini butiran untuk pengguna dengan ID 2, kami akan menghantar permintaan PATCH ke URL http: // localhost: 3000/pengguna/2 seperti yang ditunjukkan:

Mencari API REST JSON-SERVER

Menggunakan API REST json-server , anda boleh mencari melalui data untuk mencari data berdasarkan kriteria tertentu. Sebagai contoh, untuk mencari pengguna dengan nama tertentu, anda perlu menghantar permintaan GET ke URL API REST seperti yang ditunjukkan:

Seperti yang dilihat dalam imej di atas, menghantar permintaan GET ke URL http: // localhost: 3000/pengguna? Name = Shona akan mengembalikan pengguna dengan nama Shona . Begitu juga, untuk mencari pengguna dengan mana -mana bidang lain, anda perlu menambah medan itu ke rentetan pertanyaan.

Untuk melaksanakan carian teks penuh di seluruh titik akhir API REST, anda perlu menambah rentetan carian bersama -sama dengan parameter q ke titik akhir. Sebagai contoh, untuk mencari pengguna dengan maklumat yang mengandungi s carian, permintaan akan kelihatan seperti:

Mengendalikan penomboran

Semasa memaparkan grid data paginated, ia diperlukan untuk mengambil beberapa data berdasarkan penomboran. Dalam senario sedemikian, json-server menyediakan fungsi untuk menuding data JSON. Secara lalai, kiraan data yang dikembalikan dari json-server adalah 10. Kami secara jelas dapat menentukan batas ini menggunakan parameter _limit .

 http: // localhost: 3000/pengguna? _limit = 5<br>

Permintaan GET ke URL di atas akan mengembalikan lima rekod. Sekarang, untuk menuding data, kita perlu menambah parameter lain _page ke URL. _page mentakrifkan halaman yang perlu diambil untuk mengembalikan data.

 http: // localhost: 3000/pengguna? _limit = 5 & _page = 2<br>

Permintaan GET ke URL di atas akan mengembalikan halaman kedua data yang ditetapkan dengan lima rekod setiap halaman. Dengan menukar pembolehubah _page , kita boleh mengambil rekod halaman yang diperlukan.

Mengendalikan penyortiran

json-server menyediakan fungsi untuk menyusun data yang diambil. Kami boleh menyusun data dengan menyediakan nama lajur yang perlu disusun dan urutan di mana data perlu disusun. Secara lalai, data disusun dalam urutan menaik. Kami boleh memberikan nama lajur dalam url endpoint menggunakan kata kunci _sort dan tentukan pesanan menggunakan kata kunci _order . Berikut adalah url contoh:

 http: // localhost: 3000/pengguna? _sort = id & _order = desc<br>

URL di atas akan menyusun data berdasarkan Id lajur, dan ia akan disusun mengikut urutan menurun.

Pengendalian pengendali

json-server juga menyediakan fungsi untuk menyokong pengendali seperti mencari entri dengan ID dalam julat antara dua nilai atau entri yang sepadan dengan ungkapan biasa tertentu.

Untuk mencari entri dalam julat tertentu, kita boleh menggunakan pengendali _gte dan _lte . Sebagai contoh, untuk mencari pengguna dengan ID lebih besar daripada 3 dan kurang daripada 5, buatlah permintaan untuk URL http: // localhost: 3000/users? Id_gte = 3 & id_lte = 5 seperti yang ditunjukkan:

Jika kita mahu mencari nama bermula dengan huruf tertentu, kita boleh menggunakan ungkapan biasa. Sebagai contoh, untuk mencari nama yang bermula dengan huruf sa , kami akan menggunakan pengendali _like dan membuat GET untuk URL http: // localhost: 3000/pengguna? Name_like =^Sa.

Kesimpulan

Dalam tutorial ini, anda melihat cara menggunakan API REST json-server untuk membuat pangkalan data dummy untuk kegunaan cepat. Anda belajar bagaimana untuk memulakan dengan menggunakan json-server dan menanyakan URL untuk menambah, mengemas kini, mengubah suai, dan memadam data. Anda melihat bagaimana untuk menuding, menyusun, dan mencari data dummy. Anda juga melihat cara menggunakan pengendali untuk mencari penyertaan menggunakan ungkapan biasa.

Pernahkah anda menggunakan json-server atau mana-mana pelayan API REST palsu untuk penciptaan data dummy? Bagaimana pengalaman anda? Beritahu kami pemikiran anda di Forum Envato.

Atas ialah kandungan terperinci Dapatkan API REST palsu dan berjalan menggunakan pelayan JSON. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!