REST API Design: несколько вызовов против одного вызова API

Мы разрабатываем Rest API для веб-сайта электронной коммерции, который будет использоваться мобильными приложениями.

На главной странице приложения нам нужно назвать несколько ресурсов, таких как слайдеры, лучшие бренды, самые продаваемые продукты, трендовые продукты и т. Д.

Два варианта выполнения вызовов API:

Одиночный звонок:

www.example.com/api/GetAllInHome

Несколько звонков:

www.example.com/api/GetSliders

www.example.com/api/GetTopBrands

www.example.com/api/GetBestSellingProducts

www.example.com/api/GetTrendingProducts

Какой подход лучше всего подходит для остальных API? Один или несколько вызовов, объясните плюсы и минусы?

Что займет больше времени, чтобы ответить на запрос?

В теории множественные одновременные вызовы являются более гибкими и такими же быстрыми.

Однако на практике, если вы загружаете страницу, а затем загружаете каждую часть этой страницы, отображая загрузочные счетчики по всей ней, пока вы не получите результаты обратно, результат будет медленным и несвязным.

По этой причине запросы AJAX на данные должны использоваться экономно и только в том случае, если у вас есть раздел страницы, который загружается медленно или должен обновляться в другом цикле, чем остальная часть страницы. Произнесите отображение мастера / детали, где вы хотите выбрать опцию из мастера и отобразить соответствующую деталь без перезагрузки мастера.

Обычный дизайн состоит в том, чтобы сохранить отдельные API-интерфейсы для обеспечения гибкости кодирования и проблем, связанных с микросервисами, но объединять стороны сервера данных на веб-сайте. так что клиент должен сделать только один звонок на свой собственный сайт. Вызовы API с соответствующим кэшированием должны быть быстрыми в центре обработки данных.

Кроме того, подумайте об отсутствии вызовов API клиента вообще. просто сгенерируйте серверную часть HTML. Хотя одностраничные фреймворки приложений javascript продвигают вас по API-маршруту. Обычно это не оптимальный подход для крупных сайтов электронной коммерции.

TL; DR: если не учитывать все другие аспекты применения, выполнение одного вызова будет быстрее, чем выполнение нескольких вызовов. Выполнение вызовов асинхронно может сократить общее время, необходимое для выполнения данной операции с точки зрения вашего пользователя (что вполне может быть всем, что вам нужно), но в совокупности время, затрачиваемое на множественные вызовы, все равно будет больше.

В вашем случае, однако, я не уверен, что это полная история.

REST API - это немного двусмысленный термин, из-за различных толкований статьи, которые сделали идею популярной. Даже самой либеральной интерпретацией того, что представляет собой API REST, то, что у вас есть, на самом деле не подходит.

Основной принцип заключается в том, что у вас есть ресурс, на котором вы хотите выполнить действие. URI идентифицирует интересующий вас ресурс, и вы обычно используете HTTP-глаголы, чтобы указать, что вы хотите сделать с этим ресурсом.

В вашем конкретном случае все ваши методы имеют слово «get» в своем имени. Вы должны изменить глагол, используемый в HTTP-запросе, чтобы указать, что вы хотите «получить» ресурс, доступный в этом месте.

Ваша схема URI должна представлять логическую иерархию ресурсов, которые вы хотите сделать доступными для пользователей вашего API, поэтому в вашем случае я бы хотел использовать что-то вроде /api/products?category=slidersфильтрации вашей коллекции продуктов. Это означает, что когда клиенты хотят получить все ваши продукты, они могут просто пропустить строку запроса.