REST API Design: Beberapa panggilan vs. satu panggilan ke API

Kami sedang mengembangkan API Istirahat untuk situs web eCommerce yang akan dikonsumsi oleh aplikasi seluler.

Di halaman beranda aplikasi kita perlu memanggil beberapa sumber seperti Slider, Merek Top, Produk Terlaris, Produk Tren dll.

Dua opsi untuk melakukan panggilan API:

Panggilan Tunggal:

www.example.com/api/GetAllInHome

Banyak Panggilan:

www.example.com/api/GetSliders

www.example.com/api/GetTopBrands

www.example.com/api/GetBestSellingProducts

www.example.com/api/GetTrendingProducts

Yang merupakan pendekatan terbaik untuk desain api sisanya - panggilan tunggal atau ganda, jelaskan pro dan kontra?

Mana yang akan membutuhkan lebih banyak waktu untuk menanggapi permintaan?

Dalam Teori beberapa panggilan simultan lebih fleksibel dan sama cepatnya.

Namun, dalam praktiknya jika Anda memuat halaman, dan kemudian memuat setiap bagian halaman itu, menampilkan memuat pemintal di atasnya sampai Anda mendapatkan hasilnya kembali hasilnya lambat dan terputus-putus.

Untuk alasan ini, permintaan data AJAX harus digunakan dengan hemat dan hanya ketika Anda memiliki bagian halaman yang lambat dimuat atau perlu di-refresh pada siklus yang berbeda ke bagian halaman lainnya. Ucapkan tampilan master / detail, tempat Anda ingin memilih opsi dari master dan tampilkan detail yang sesuai tanpa memuat ulang master.

Desain yang umum adalah menjaga API terpisah untuk fleksibilitas pengkodean dan masalah layanan mikro, tetapi menggabungkan sisi server data di situs web. sehingga klien hanya perlu melakukan satu panggilan ke situs webnya sendiri. Panggilan API dengan caching yang sesuai harus cepat di dalam pusat data.

Selain itu, pertimbangkan untuk tidak memiliki panggilan API klien sama sekali. cukup buat sisi server HTML. Meskipun kerangka kerja aplikasi satu halaman javascript mendorong Anda ke rute api. Ini biasanya bukan pendekatan yang optimal untuk situs e-commerce volume tinggi.

TL; DR: Di samping semua pertimbangan aplikasi lain, melakukan satu panggilan akan lebih cepat daripada melakukan beberapa panggilan. Menjalankan panggilan secara tidak sinkron dapat mengurangi waktu keseluruhan yang diperlukan untuk menyelesaikan operasi yang diberikan dari perspektif pengguna Anda (yang mungkin merupakan semua yang Anda butuhkan), tetapi secara agregat, waktu yang dibutuhkan masih lebih lama untuk beberapa panggilan.

Namun dalam kasus Anda, saya tidak yakin itu cerita lengkapnya.

API REST adalah istilah yang agak ambigu, karena berbagai interpretasi dari makalah yang membuat ide populer. Namun, bahkan oleh penafsiran paling liberal tentang apa yang merupakan API REST, apa yang Anda miliki tidak begitu cocok.

Prinsip intinya adalah bahwa Anda memiliki sumber daya di mana Anda ingin melakukan suatu tindakan. URI mengidentifikasi sumber daya yang Anda minati, dan Anda biasanya akan menggunakan kata kerja HTTP untuk menunjukkan apa yang ingin Anda lakukan terhadap sumber daya itu.

Dalam kasus spesifik Anda, semua metode Anda memiliki kata 'get' dalam nama mereka. Anda harus mengubah kata kerja yang digunakan dalam permintaan HTTP untuk menunjukkan bahwa Anda ingin 'mendapatkan' sumber daya yang tersedia di lokasi itu.

Skema URI Anda harus mewakili hierarki logis dari sumber daya yang ingin Anda sediakan bagi pengguna API Anda, jadi dalam kasus Anda saya akan mempertimbangkan menggunakan sesuatu seperti /api/products?category=slidersuntuk menyaring koleksi produk Anda. Ini berarti bahwa ketika klien ingin mendapatkan semua produk Anda, mereka dapat dengan mudah menghilangkan string kueri.