ستوضح لك هذه المقالة كيفية العمل مع واجهات برمجة التطبيقات على نظامنا الأساسي بدون رمز احترافي ، AppMaster.io. لكن ، أولاً ، دعنا نذكرك ببعض المعلومات الأساسية حول واجهة برمجة التطبيقات.
مقدمة
API تعني واجهة برمجة التطبيقات. هذه هي الطريقة التي يمكن بها للعميل والخادم التواصل مع بعضهما البعض. يرسل العميل والخادم الطلبات والاستجابات ، وتعمل واجهة برمجة التطبيقات كوسيط بينهما.
يجب أن يكون هذا التفاعل بين العميل والخادم بسيطًا ومفهومًا ومريحًا. إنه يبسط مهام المطورين (لا حاجة لإعادة اختراع خدمة جديدة) والمستخدمين (الخدمة أسهل في معرفة ما إذا كانت تعمل بشكل مألوف). هناك عدة أنواع من واجهات برمجة التطبيقات:
- واجهات برمجة تطبيقات خدمة الويب و XML-RPC و JSON-RPC و SOAP ؛
- واجهات برمجة تطبيقات WebSockets ؛
- واجهات برمجة التطبيقات القائمة على المكتبة ، جافا سكريبت ؛
- واجهات برمجة التطبيقات القائمة على الفصل ، C # API ، جافا.
على النظام الأساسي AppMaster.io بدون رمز ، نستخدم نمط واجهة برمجة تطبيقات REST.
REST أو نقل الحالة التمثيلية بالكامل هو النمط المعماري للتفاعل (تبادل المعلومات) بين العميل والخادم. تتواصل الخدمات في REST API باستخدام بروتوكول HTTP.
نمط REST له مزايا معينة. الميزة الرئيسية لـ REST هي المرونة الممتازة. يتكون REST من إرشادات بسيطة ، مما يسمح للمطورين بتنفيذ المتطلبات بتنسيقهم. يتمتع REST بأداء عالٍ ، وهو أمر مهم جدًا ، على سبيل المثال ، للتحميل السريع على الأجهزة المحمولة. هذا هو السبب في أن جميع الشركات الكبيرة مثل Twitter و Google قد نفذت منذ فترة طويلة واجهة برمجة تطبيقات REST لمنتجاتها. يمكنك قراءة المزيد حول العمل والمزايا الرئيسية لواجهة برمجة تطبيقات REST في مقالتنا.
تتضمن بنية أي طلب خمسة مكونات رئيسية: طريقة HTTP ونقاط النهاية والعناوين والجسم ومعلمات الطلب.
تستخدم واجهة برمجة تطبيقات REST 4 طرق HTTP أساسية للعمل مع مورد (معلومات) ، ويصف كل منها ما يجب فعله بالمورد:
- ما بعد - إنشاء الموارد ؛
- الحصول على - الحصول على مورد ؛
- PUT - تحديث الموارد ؛
- حذف - حذف مورد.
المورد هو أي معلومات (مستند ، صورة ، فيديو ، نص ، وما إلى ذلك). على النظام الأساسي بدون كود AppMaster.io ، يتم تسليم هذه المعلومات إلى العميل بتنسيقات متعددة ، بما في ذلك أكثرها شيوعًا - JSON.
تحتوي نقطة النهاية على URI - معرف المورد الموحد (معرف مورد موحد) ، والذي يشير إلى مكان وكيفية العثور على مورد على الإنترنت ويتضمن عنوان URL (عنوان URL أو موقع المورد الموحد هو عنوان ويب كامل).
تنقل الرؤوس المعلومات إلى كل من العميل والخادم. توفر الرؤوس بشكل أساسي بيانات المصادقة: مفتاح API ، والاسم أو عنوان IP للكمبيوتر الذي تم تثبيت الخادم عليه ، وتنسيق الاستجابة.
الجسم مطلوب لتمرير معلومات إضافية إلى الخادم: بيانات الجسم هي البيانات التي تريد ، على سبيل المثال ، إضافتها أو استبدالها.
يتم إنشاء وثائق API لتطبيقك على نظامنا الأساسي تلقائيًا وتخزينها بتنسيق OpenAPI (Swagger) في الواجهة الخلفية.
لا تحتاج إلى فهم كيفية عملها بدقة لتتعلم كيفية إنشاء واجهة برمجة تطبيقات على AppMaster.io. ستفهم المبادئ الأساسية من خلال التعرف على أدوات النظام الأساسي. بالإضافة إلى ذلك ، يتم إنشاء الجزء المركزي من API بواسطة AppMaster.io. يتم إجراء معظم الإعدادات بشكل افتراضي أو عند توصيل الوحدات النمطية. على سبيل المثال ، توفر وحدتنا أدوات للتكامل مع واجهات برمجة التطبيقات للبريد.
ستحتاج إلى إجراء تغييرات طفيفة على بعض إعدادات واجهة برمجة التطبيقات يدويًا عند دمج (توصيل) تطبيقك بتطبيقات أخرى أو موارد خارجية. بعد ذلك ، سوف ننظر في كيفية القيام بذلك.
إنشاء API باستخدام منصة لا تحتوي على كود AppMaster.io
لذلك ، يمكنك العثور على إعدادات API في عدة أماكن على نظامنا الأساسي.
كيفية إنشاء نقطة نهاية API على النظام الأساسي بدون رمز AppMaster.io
تسجيل الدخول إلى حسابك لمشروع قائم.
انتقل إلى مصمم نماذج البيانات. في Data Model Designer ، سترى نماذج تحتوي على بيانات تريد معالجتها باستخدام واجهة برمجة تطبيقات نقاط النهاية. في كل مشروع ، في البداية ، هناك دائمًا نموذج واحد افتراضيًا ، وهو المستخدم. إذا كنت تعمل في مشروع جديد وليس لديك نماذجك بعد ، فقم بإنشائها.
قم بتعيين روابط بين النماذج الخاصة بك وحفظ المشروع.
انتقل إلى قسم نقاط النهاية في القائمة اليسرى من الشاشة.
هنا سترى قائمة بجميع نقاط النهاية الخاصة بك وطرق REST API المتاحة لهم المتصلة بكل نموذج في مجال المشروع. ستقوم بإزالة الطرق غير الضرورية وتغيير إعداداتها (رمز الترس وأيقونة سلة المحذوفات).
إذا لم تكن هناك نقطة نهاية مناسبة في القائمة ، فيمكنك إنشاء نقطة نهاية جديدة بالنقر فوق الزر نقطة نهاية جديدة واختيار النوع المناسب. سيتم فتح نافذة مشروطة مع إعدادات نقطة النهاية.
كيفية إنشاء واجهة برمجة تطبيقات خارجية على النظام الأساسي بدون رمز AppMaster.io
انتقل إلى قسم منطق الأعمال في القائمة اليسرى.
هنا يمكنك إنشاء طلب API خارجي في علامة التبويب طلب واجهة برمجة التطبيقات الخارجية (هذا الخيار في مرحلة تجريبية).
بالإضافة إلى ذلك ، كما ذكرنا أعلاه ، يتم إنشاء جميع الوثائق تلقائيًا وحفظها بتنسيق OpenAPI (Swagger) في النهاية الخلفية للتطبيق الخاص بك.
Swagger هو التوثيق والقدرة على اختبار جميع نقاط النهاية في الحال دون استخدام تطبيقات الطرف الثالث مثل Postman.
استنتاج
كما ترى ، فإن إنشاء إعدادات واجهة برمجة التطبيقات وتغييرها باستخدام عدم وجود رمز أمر بسيط للغاية ويستغرق الحد الأدنى من الوقت. إذا لم يكن لديك حساب على AppMaster.io حتى الآن ، فقم بالانضمام إلينا والاشتراك للحصول على إصدار تجريبي .