يعد التعامل مع ترقيم الصفحات في واجهات برمجة تطبيقات REST جانبًا مهمًا في تصميم واجهة برمجة التطبيقات، خاصة بالنسبة لموفر واجهة برمجة التطبيقات مثلنا. يسمح لنا ترقيم الصفحات بإدارة مجموعات البيانات الكبيرة بشكل فعال، وتحسين الأداء وتجربة المستخدم. في هذه المدونة، سنستكشف تقنيات مختلفة للتعامل مع ترقيم الصفحات في REST APIs، ونناقش إيجابياتها وسلبياتها، ونقدم أمثلة عملية.
لماذا يعد ترقيم الصفحات ضروريًا
عند التعامل مع مجموعات كبيرة من البيانات، قد يكون إرجاع جميع البيانات في استجابة واحدة غير فعال ويستهلك الكثير من الموارد. يمكن أن يؤدي ذلك إلى أوقات استجابة طويلة، واستخدام مرتفع للذاكرة على كل من الخادم والعميل، وازدحام محتمل في الشبكة. يحل ترقيم الصفحات هذه المشكلات عن طريق تقسيم مجموعة البيانات إلى "صفحات" أصغر وأكثر قابلية للإدارة وإرجاع صفحة واحدة في كل مرة.
تقنيات ترقيم الصفحات الشائعة
إزاحة - الحد من ترقيم الصفحات
الإزاحة - يعد ترقيم الصفحات المحدود أحد أكثر التقنيات المباشرة والأكثر استخدامًا. يتضمن تحديد معلمتين:إزاحةوحد. الإزاحةيشير إلى موضع البداية للبيانات المراد استردادها، وحديحدد الحد الأقصى لعدد العناصر المراد إرجاعها في الاستجابة.
على سبيل المثال، إذا كان لدينا نقطة نهاية API/api/productsالتي تقوم بإرجاع قائمة المنتجات، طلب معالإزاحة = 20والحد = 10سيعيد المنتج الحادي والعشرين إلى المنتج الثلاثين.
فيما يلي مثال Python Flask لتطبيق ترقيم الصفحات المحدود:
من قارورة استيراد قارورة، طلب، jsonify app = Flask(__name__) المنتجات = [{"id": i, "name": f"Product {i}"} for i in range(100)] @app.route('/api/products',methods=['GET']) def get_products(): offset = int(request.args.get('offset', 0)) Limit = int(request.args.get('limit', 10)) paginated_products = المنتجات[offset:offset + Limit] إرجاع jsonify(paginated_products) إذا __name__ == '__main__': app.run(debug=True)الايجابيات:
- من السهل أن نفهم وتنفيذها.
- يعمل بشكل جيد مع قواعد البيانات التي تدعم
حدوإزاحةعبارات، مثل MySQL وPostgreSQL.
سلبيات:
- كما
إزاحةمع زيادة القيمة، يمكن أن يتدهور الأداء بشكل كبير، خاصة بالنسبة لمجموعات البيانات الكبيرة. وذلك لأن قاعدة البيانات يجب أن تتخطى عددًا كبيرًا من الصفوف للوصول إلى الإزاحة المطلوبة. - قد يكون من الصعب التعامل مع البيانات التي يتم تحديثها أثناء تقسيم الصفحات، حيث أن الإزاحة قد لا تشير إلى الموضع الصحيح.
المؤشر - ترقيم الصفحات
يستخدم ترقيم الصفحات المستند إلى المؤشر معرفًا فريدًا (المؤشر) لتحديد الموضع في مجموعة البيانات. بدلاً من تحديد الإزاحة، يوفر العميل قيمة المؤشر في الطلب للحصول على الصفحة التالية من البيانات.
على سبيل المثال، إذا كانت لدينا قائمة بالمستخدمين مرتبة حسب تاريخ الإنشاء، فقد يكون المؤشر هو تاريخ إنشاء آخر مستخدم في الصفحة السابقة. سيقوم الخادم بعد ذلك بإرجاع المجموعة التالية من المستخدمين بتاريخ إنشاء أكبر من قيمة المؤشر.
فيما يلي مثال بسيط لجافا سكريبت باستخدام Node.js وExpress:
const Express = require('express'); تطبيق const = Express(); const users = [ { id: 1, name: 'User 1', create_at: '2023-01-01' }, { id: 2, name: 'User 2', create_at: '2023-01-02' }, // المزيد من المستخدمين... ]; app.get('/api/users', (req, res) => { const cursor = req.query.cursor; const Limit = parseInt(req.query.limit) || 10; Let startIndex = 0; if (cursor) { startIndex = users.findIndex(user => user.created_at > cursor); } const paginatedUsers = users.slice(startIndex, startIndex + Limit); const nextCursor = paginatedUsers.length > 0 ? paginatedUsers[paginatedUsers.length - 1].created_at : null; app.listen(3000, () => { console.log('الخادم يعمل على المنفذ 3000'); });الايجابيات:
- أداء أفضل مقارنة بالإزاحة - الحد من ترقيم الصفحات، خاصة بالنسبة لمجموعات البيانات الكبيرة. لا يتطلب من قاعدة البيانات تخطي عدد كبير من الصفوف.
- أكثر قوة عند التعامل مع تحديثات البيانات، حيث يشير المؤشر دائمًا إلى موضع محدد في مجموعة البيانات.
سلبيات:
- أكثر تعقيدًا في التنفيذ، خاصة عند التعامل مع معايير فرز متعددة.
- يتطلب معرفًا فريدًا وقابلاً للفرز لاستخدامه كمؤشر.
ترقيم الصفحات رقم الصفحة
يشبه ترقيم الصفحات لرقم الصفحة الإزاحة - ترقيم الصفحات المحدد، ولكن بدلاً من تحديد إزاحة، يطلب العميل رقم صفحة محددًا. يقوم الخادم بحساب الإزاحة بناءً على رقم الصفحة والحد الأقصى.
على سبيل المثال، إذا كان الحد الأقصى هو 10 عناصر لكل صفحة، فإن طلب الصفحة 3 سيكون له إزاحة قدرها 20 (نظرًا لأنالإزاحة = (رقم_الصفحة - 1) * الحد).
من قارورة استيراد قارورة، طلب، jsonify app = Flask(__name__) المنتجات = [{"id": i, "name": f"Product {i}"} for i in range(100)] @app.route('/api/products', أساليب=['GET']) def get_products(): page = int(request.args.get('page', 1)) Limit = int(request.args.get('limit', 10)) offset = (page - 1) * Limit paginated_products = Products[offset:offset + Limit] return jsonify(paginated_products) if __name__ == '__main__': app.run(debug=True)الايجابيات:
- من السهل على المستخدمين فهمه، لأنه يشبه ترقيم الصفحات التقليدي في صفحات الويب.
- بسيطة للتنفيذ.
سلبيات:
- كما هو الحال مع الإزاحة - تحديد ترقيم الصفحات، يمكن أن تعاني من مشكلات في الأداء مع زيادة رقم الصفحة.
- قد يكون من الصعب التعامل مع تحديثات البيانات أثناء تقسيم الصفحات.
اعتبارات لموفري API
باعتبارنا مزود واجهة برمجة التطبيقات، نحتاج إلى مراعاة عدة عوامل عند تنفيذ ترقيم الصفحات:
التوحيد القياسي
يجب أن نتبع الممارسات الصناعية القياسية لترقيم الصفحات. يتضمن ذلك استخدام أسماء معلمات متسقة (مثلإزاحة,حد,صفحة,المؤشر)، وتوفير وثائق واضحة حول كيفية عمل ترقيم الصفحات.
البيانات الوصفية
بالإضافة إلى البيانات المقسمة إلى صفحات، يجب علينا توفير البيانات الوصفية في الرد، مثل إجمالي عدد العناصر، وإجمالي عدد الصفحات، وروابط الصفحات التالية والسابقة. يساعد ذلك العميل على فهم مجموعة البيانات بشكل أفضل والتنقل عبر الصفحات.
على سبيل المثال، يمكن أن يكون الرد بالتنسيق التالي:
{ "data": [ { "id": 1, "name": "المنتج 1" }, { "id": 2, "name": "المنتج 2" } ], "total_items": 100, "total_pages": 10, "next_page": "/api/products?offset=20&limit=10", "prev_page": null }حماية
نحتاج إلى التأكد من التحقق من صحة معلمات ترقيم الصفحات بشكل صحيح لمنع حقن SQL أو أي ثغرات أمنية أخرى. على سبيل المثال، يجب علينا تحويلإزاحةوحدمعلمات للأعداد الصحيحة ووضع حدود معقولة لمنع الاستهلاك المفرط للموارد.
خاتمة
يعد التعامل مع ترقيم الصفحات في واجهات برمجة تطبيقات REST مهارة مهمة لموفري واجهة برمجة التطبيقات. من خلال اختيار تقنية ترقيم الصفحات الصحيحة استنادًا إلى حجم مجموعة البيانات ومتطلبات الأداء وتجربة المستخدم، يمكننا توفير واجهة برمجة تطبيقات أكثر كفاءة وسهولة في الاستخدام. سواء كنت تتعامل مع مجموعة بيانات صغيرة أو تطبيق واسع النطاق، فإن فهم إيجابيات وسلبيات طرق ترقيم الصفحات المختلفة أمر ضروري.
إذا كنت مهتمًا بواجهات برمجة التطبيقات الخاصة بنا أو كانت لديك أي أسئلة حول ترقيم الصفحات أو المواضيع الأخرى ذات الصلة بواجهة برمجة التطبيقات، فلا تتردد في الاتصال بنا للشراء وإجراء المزيد من المناقشات. كما نقدم مجموعة واسعة من المنتجات مثلميثوكاربامول,أزازيترون هيدروكلوريد، وبيرازيناميد.
مراجع
- ريتشاردسون، ليونارد، وسام روبي. خدمات الويب المريحة. أورايلي ميديا، 2007.
- البنوك، آدم. بناء واجهات برمجة تطبيقات الويب RESTful باستخدام Python وFlask. باكت للنشر، 2018.