مرحبًا يا من هناك! كمورد لواجهات برمجة التطبيقات (APIs)، يسعدني أن أشارككم كيفية إنشاء REST API. REST، الذي يرمز إلى نقل الحالة التمثيلية، هو أسلوب معماري يستخدم على نطاق واسع لبناء خدمات الويب. إنها مرنة للغاية وقابلة للتطوير وسهلة الفهم، مما يجعلها الخيار الأفضل للمطورين حول العالم.
فهم أساسيات الراحة
قبل أن نتعمق في إنشاء REST API، دعنا نتعرف سريعًا على ما تعنيه REST. يعتمد REST على مجموعة من المبادئ التي تجعل خدمات الويب أكثر كفاءة وموثوقية. تتضمن المفاهيم الأساسية الموارد، وهي البيانات أو الكائنات التي تريد الكشف عنها من خلال واجهة برمجة التطبيقات الخاصة بك، وطرق HTTP مثل GET وPOST وPUT وDELETE.
- يحصل: يستخدم لاسترداد الموارد. على سبيل المثال، إذا كان لديك واجهة برمجة تطبيقات لمكتبة، فيمكن استخدام طلب GET للحصول على قائمة بجميع الكتب.
- بريد: يستخدم لإنشاء مورد جديد. في مثال المكتبة، يمكن استخدام طلب POST لإضافة كتاب جديد إلى المجموعة.
- يضع: يستخدم لتحديث مورد موجود. يمكنك استخدام طلب PUT لتحديث تفاصيل كتاب معين.
- يمسح: يستخدم لإزالة مورد. لذلك، إذا كنت تريد حذف كتاب من المكتبة، فيمكنك استخدام طلب الحذف.
التخطيط لواجهة برمجة تطبيقات REST الخاصة بك
الخطوة الأولى في إنشاء REST API هي التخطيط. أنت بحاجة إلى معرفة الموارد التي تريد الكشف عنها وكيف سيتم تنظيمها. فكر في نماذج البيانات والعلاقات بين الموارد المختلفة. على سبيل المثال، إذا كنت تقوم بإنشاء واجهة برمجة تطبيقات (API) لمتجر للتجارة الإلكترونية، فقد يكون لديك موارد مثل المنتجات والعملاء والطلبات.
تحتاج أيضًا إلى اتخاذ قرار بشأن نقاط نهاية واجهة برمجة التطبيقات (API). هذه هي عناوين URL التي سيستخدمها العملاء للتفاعل مع واجهة برمجة التطبيقات (API) الخاصة بك. من الممارسات الجيدة استخدام الأسماء لتمثيل الموارد في نقاط النهاية الخاصة بك. على سبيل المثال،/منتجاتيمكن أن تكون نقطة النهاية للحصول على قائمة بجميع المنتجات، و/المنتجات/{product_id}يمكن استخدامها للحصول على تفاصيل منتج معين.
تهيئة بيئة التطوير
بمجرد تخطيط واجهة برمجة التطبيقات (API) الخاصة بك، فقد حان الوقت لإعداد بيئة التطوير الخاصة بك. ستحتاج إلى لغة برمجة وإطار عمل. تتضمن الخيارات الشائعة لإنشاء واجهات برمجة التطبيقات REST API Python مع Flask أو Django، وNode.js مع Express، وJava مع Spring Boot.
لنفترض أنك اخترت Python وFlask. أولاً، ستحتاج إلى تثبيت Python إذا لم تكن قد قمت بذلك بالفعل. وبعد ذلك، يمكنك تثبيت Flask باستخدامقارورة تثبيت النقطة. فيما يلي مثال بسيط لتطبيق Flask الذي يقوم بإنشاء واجهة برمجة تطبيقات REST الأساسية:
من قارورة استيراد قارورة، jsonify app = Flask(__name__) @app.route('/') def Index(): return jsonify({'message': 'مرحبًا بك في واجهة برمجة التطبيقات الخاصة بنا!'}) if __name__ == '__main__': app.run(debug=True)في هذا المثال، قمنا بإنشاء واجهة برمجة تطبيقات بسيطة ذات نقطة نهاية واحدة (/) الذي يُرجع استجابة JSON.
تنفيذ نقاط نهاية API
الآن بعد أن تم إعداد بيئتك، فقد حان الوقت لتنفيذ نقاط نهاية واجهة برمجة التطبيقات (API). دعونا نواصل مع مثال التجارة الإلكترونية. سنقوم بإنشاء نقاط النهاية للحصول على قائمة المنتجات وإضافة منتج جديد.
from flask import Flask, jsonify, request app = Flask(__name__) # نموذج بيانات للمنتجات المنتجات = [ {'id': 1, 'name': 'Product 1', 'price': 10.99}, {'id': 2, 'name': 'Product 2', 'price': 19.99} ] @app.route('/products',methods=['GET']) def get_products(): return jsonify(products) @app.route('/products',methods=['POST']) def add_product(): new_product = request.get_json() المنتجات.append(new_product) return jsonify(new_product), 201 if __name__ == '__main__': app.run(debug=True)في هذا الكود،/منتجاتتقوم نقطة النهاية باستخدام أسلوب GET بإرجاع قائمة بجميع المنتجات، وتضيف نقطة النهاية نفسها باستخدام أسلوب POST منتجًا جديدًا إلى القائمة.
معالجة الأخطاء والتحقق من صحتها
يجب أن تتعامل واجهة REST API الجيدة مع الأخطاء بأمان وتتحقق من صحة الإدخال. على سبيل المثال، إذا أرسل العميل طلبًا غير صالح، فيجب أن تعرض واجهة برمجة التطبيقات (API) الخاصة بك رسالة خطأ مناسبة.
من القارورة استيراد القارورة، jsonify، طلب التطبيق = Flask(__name__) المنتجات = [ {'id': 1, 'name': 'Product 1', 'price': 10.99}, {'id': 2, 'name': 'Product 2', 'price': 19.99} ] @app.route('/products', الأساليب=['GET']) def get_products(): return jsonify(products) @app.route('/products',methods=['POST']) def add_product(): new_product = request.get_json() إذا لم يكن new_product أو 'name' ليس في new_product أو 'price' ليس في new_product: return jsonify({'error': 'بيانات المنتج غير صالحة'})، 400 منتج.append(new_product) return jsonify(new_product)، 201 إذا __name__ == '__main__': app.run(debug=True)هنا، قمنا بإضافة التحقق من الصحة إلىadd_productوظيفة. إذا لم يرسل العميل بيانات منتج صالحة، فستُرجع واجهة برمجة التطبيقات خطأ طلب غير صالح 400.
تأمين REST API الخاص بك
يعد الأمان أمرًا بالغ الأهمية عندما يتعلق الأمر بـ REST APIs. تحتاج إلى حماية واجهة برمجة التطبيقات (API) الخاصة بك من الوصول غير المصرح به. إحدى الطرق الشائعة للقيام بذلك هي استخدام المصادقة والترخيص.
- المصادقة: هذا يتحقق من هوية العميل. يمكنك استخدام طرق مثل مفاتيح API أو OAuth أو JSON Web Tokens (JWT). على سبيل المثال، إذا كنت تستخدم مفاتيح واجهة برمجة التطبيقات، فسيحتاج العميل إلى إرسال مفتاح واجهة برمجة تطبيقات صالح في رؤوس الطلب للوصول إلى واجهة برمجة التطبيقات.
- إذن: يحدد هذا الإجراءات التي يُسمح للعميل بتنفيذها. بمجرد مصادقة العميل، يمكنك التحقق مما إذا كان لديه الأذونات اللازمة للوصول إلى مورد معين أو تنفيذ إجراء ما.
اختبار REST API الخاص بك
قبل نشر واجهة برمجة التطبيقات (API) الخاصة بك، يتعين عليك اختبارها بدقة. يمكنك استخدام أدوات مثل Postman أو cURL لإرسال الطلبات إلى واجهة برمجة التطبيقات الخاصة بك والتحقق من الردود.
على سبيل المثال، لاختبارget_productsنقطة النهاية باستخدام cURL، يمكنك تشغيل الأمر التالي:
حليقة http://127.0.0.1:5000/productsسيؤدي هذا إلى إرسال طلب GET إلى/منتجاتنقطة النهاية وعرض الاستجابة.
نشر REST API الخاص بك
بمجرد اختبار واجهة برمجة التطبيقات الخاصة بك وعملها بشكل صحيح، فقد حان الوقت لنشرها. يمكنك استخدام الأنظمة الأساسية السحابية مثل Heroku أو AWS أو Google Cloud. تعمل هذه الأنظمة الأساسية على تسهيل نشر وإدارة واجهة برمجة التطبيقات (API) الخاصة بك.
عروض واجهات برمجة التطبيقات لدينا
باعتبارنا موردًا لواجهات برمجة التطبيقات، فإننا نقدم مجموعة واسعة من واجهات برمجة التطبيقات لمختلف الصناعات. على سبيل المثال، لدينا واجهات برمجة التطبيقات لمسحوق أمبروكسان 6790 - 58 - 5,مسحوق الكينين هيدروكلورايد 60 - 93 - 5، وC12 - 20 ألكيل جلوكوزيد. تم تصميم واجهات برمجة التطبيقات هذه لتوفير وصول سهل إلى البيانات والوظائف المتعلقة بهذه المنتجات، مما يساعدك على تبسيط عمليات عملك.
تواصل معنا للمشتريات
إذا كنت مهتمًا بواجهات برمجة التطبيقات الخاصة بنا أو ترغب في مناقشة إنشاء واجهة REST API مخصصة لاحتياجاتك المحددة، فلا تتردد في التواصل معنا. نحن هنا لمساعدتك في تحقيق أقصى استفادة من تقنية REST API والارتقاء بأعمالك إلى المستوى التالي.
مراجع
- ريتشاردسون، ليونارد، وسام روبي. خدمات الويب المريحة. أورايلي ميديا، 2007.
- يونغ، مايك. "تصميم واجهة برمجة تطبيقات الويب RESTful." أنماط وممارسات مايكروسوفت، 2013.