Thiết kế API REST: Nhiều cuộc gọi so với một cuộc gọi đến API

Chúng tôi đang phát triển API nghỉ ngơi cho trang web Thương mại điện tử sẽ được các ứng dụng di động sử dụng.

Trong trang chủ của một ứng dụng, chúng ta cần gọi nhiều tài nguyên như Thanh trượt, Thương hiệu hàng đầu, Sản phẩm bán chạy nhất, Sản phẩm thịnh hành, v.v.

Hai tùy chọn để thực hiện cuộc gọi API:

Cuộc gọi đơn

www.example.com/api/GetAllInHome

Nhiều cuộc gọi:

www.example.com/api/GetSliders

www.example.com/api/GetTopBrands

www.example.com/api/GetBestSellingProducts

www.example.com/api/GetTrendingProducts

Đó là cách tiếp cận tốt nhất cho thiết kế api còn lại - cuộc gọi đơn hoặc nhiều cuộc gọi, giải thích những ưu và nhược điểm?

Mà sẽ mất nhiều thời gian hơn để đáp ứng yêu cầu?

Trong Lý thuyết , nhiều cuộc gọi đồng thời linh hoạt hơn và nhanh như vậy.

Tuy nhiên, trong thực tế nếu bạn tải một trang, sau đó tải từng phần của trang đó, hiển thị tải các spinners trên tất cả cho đến khi bạn nhận được kết quả trở lại thì kết quả bị chậm và rời rạc.

Vì lý do này, các yêu cầu dữ liệu AJAX nên được sử dụng một cách tiết kiệm và chỉ khi bạn có một phần của trang tải chậm hoặc cần được làm mới trên một chu kỳ khác với phần còn lại của trang. Nói một màn hình chính / chi tiết, trong đó bạn muốn chọn một tùy chọn từ bản gốc và hiển thị chi tiết tương ứng mà không cần tải lại bản gốc.

Một thiết kế phổ biến là giữ các API riêng biệt để linh hoạt mã hóa và các mối quan tâm về dịch vụ vi mô, nhưng kết hợp phía máy chủ dữ liệu trong trang web. để khách hàng chỉ cần thực hiện một cuộc gọi đến trang web của riêng mình. Các lệnh gọi API với bộ nhớ đệm thích hợp phải nhanh trong trung tâm dữ liệu.

Ngoài ra, hãy cân nhắc việc KHÔNG có các lệnh gọi API khách hàng nào cả. chỉ cần tạo phía máy chủ HTML. Mặc dù các khung ứng dụng trang đơn javascript đẩy bạn xuống tuyến đường api. Nó thường không phải là cách tiếp cận tối ưu cho các trang web thương mại điện tử số lượng lớn.

TL; DR: Tất cả các cân nhắc ứng dụng khác sang một bên, thực hiện một cuộc gọi sẽ nhanh hơn thực hiện nhiều cuộc gọi. Chạy các cuộc gọi không đồng bộ có thể cắt giảm tổng thời gian cần thiết để hoàn thành một thao tác nhất định theo quan điểm của người dùng của bạn (có thể là tất cả những gì bạn cần), nhưng tổng hợp, thời gian thực hiện vẫn sẽ lâu hơn cho nhiều cuộc gọi.

Tuy nhiên, trong trường hợp của bạn, tôi không chắc đó là câu chuyện đầy đủ.

API REST là một thuật ngữ hơi mơ hồ, do nhiều cách hiểu khác nhau của bài báo đã khiến ý tưởng trở nên phổ biến. Tuy nhiên, bằng cách giải thích tự do nhất về những gì cấu thành API REST, tuy nhiên, những gì bạn không thực sự phù hợp.

Nguyên tắc cốt lõi là bạn có một tài nguyên mà bạn muốn thực hiện một hành động. URI xác định tài nguyên bạn quan tâm và thông thường bạn sẽ sử dụng các động từ HTTP để chỉ ra những gì bạn muốn làm với tài nguyên đó.

Trong trường hợp cụ thể của bạn, tất cả các phương thức của bạn đều có từ 'get' trong tên của chúng. Bạn nên thay đổi động từ được sử dụng trong yêu cầu HTTP để cho biết rằng bạn muốn 'lấy' tài nguyên có sẵn tại địa điểm đó.

Lược đồ URI của bạn phải thể hiện hệ thống phân cấp logic của các tài nguyên bạn muốn cung cấp cho người dùng API của bạn, vì vậy trong trường hợp của bạn, tôi sẽ cân nhắc sử dụng một cái gì đó như /api/products?category=slidersđể lọc bộ sưu tập sản phẩm của bạn. Điều này có nghĩa là khi khách hàng muốn nhận tất cả các sản phẩm của bạn, họ có thể bỏ qua chuỗi truy vấn.