يعد إجراء استدعاء API داخل VS Code أمرًا سهلاً ، فقط قم بتثبيت امتداد واحد ، وبعد ذلك لن تضطر إلى الاعتماد على أي أدوات خارجية لإنجاز المهمة.
أثناء التطوير ، من الشائع بالنسبة لك تقديم طلبات إلى واجهات برمجة التطبيقات. قد يكون هذا لبعض واجهة برمجة التطبيقات الخارجية أو واجهة برمجة التطبيقات لخادم الواجهة الخلفية.
يمكنك استخدام أدوات الطرف الثالث مثل Postman لإجراء مكالمات API الخاصة بك. لكن امتداد VS Code يسمح لك بإجراء مكالمات API مباشرة من داخل VS Code. هنا ، ستتعلم كيفية تنفيذ طلبات API في VS Code.
ملحق عميل VS Code REST
الامتداد في VS Code هو مكون إضافي أو وظيفة إضافية تعزز وظائف محرر Visual Studio Code. يوفر سوق ملحقات VS Code عدة أنواع من الإضافات التي يمكن أن تساعدك في مهام البرمجة الخاصة بك. هناك امتداد لإضافة دعم اللغة. هناك واحد لتوفير الإكمال التلقائي للغة برمجة معينة وما إلى ذلك. تجعل الإضافات من السهل البرمجة باستخدام VS Code.
يسمح لك امتداد REST Client بتنفيذ طلبات API من داخل VS Code. يتضمن الامتداد محرر REST API ، وهو واجهة مرئية تتيح لك الاستعلام عن نقاط نهاية API. يقبل الرؤوس المخصصة ومعلمات الاستعلام وبعض المعلمات الأخرى.
لتثبيت ملف عميل REST، افتح VS Code وانقر على ملحقات فاتورة غير مدفوعة. بحث عن عميل REST وانقر فوق ثَبَّتَ زر لإضافته إلى رمز VS.
تحت تفاصيل علامة التبويب ، ستجد برنامجًا تعليميًا مفيدًا حول كيفية استخدام العميل لتقديم طلبات واجهة برمجة التطبيقات. دعونا نرى الأنواع الأربعة الشائعة من الطلبات وكيفية إجرائها باستخدام امتداد REST Client.
سوف نستخدم JSON لتوضيح إجراء مكالمات API باستخدام ملحق REST Client. يوفر ستة موارد مشتركة يمكنك قراءتها أو تعديلها أو تحديثها أو حذفها عن طريق تقديم طلبات واجهة برمجة التطبيقات.
إجراء طلب GET باستخدام ملحق عميل REST
ابدأ بإنشاء ملف .http ملف لطلبات API الخاصة بك. يمكنك تسمية الملف طلباتي.
أضف الكود التالي إلى ملف طلباتي ملف لاسترداد مورد من JSONPlaceholder API الذي يحتوي على 1 كمعرّف:
يحصل https://jsonplaceholder.typicode.com/posts/1 HTTP / 1.1لإرسال الطلب ، انقر فوق ارسل طلب الذي يظهر أعلى الملف. ستفتح نافذة جديدة تحتوي على تفاصيل الرد.
هذه هي الطريقة التي تقدم بها طلب GET داخل VS Code.
إجراء طلب POST باستخدام ملحق عميل REST
تقوم بإجراء طلب POST عندما تريد نشر البيانات على الخادم ، عادةً لإنشاء مورد جديد.
لإنشاء مورد جديد في JSONPlaceholder API ، استبدل الكود الموجود في ملف طلباتي ملف مع ما يلي:
بريد https://jsonplaceholder.typicode.com/posts HTTP / 1.1
نوع المحتوى: "application / json"
{
"العنوان": "foo"،
"الجسم": "شريط" ،
"معرف المستخدم": 1
}
انقر على ارسل طلب زر لإرسال الطلب. مرة أخرى ، سيؤدي هذا إلى فتح نافذة جديدة تحتوي على بيانات الاستجابة. يظهر الرد أن تم إنشاء HTTP / 1.1 201 الرسالة ومعرف المنشور إلى جانب البيانات الأخرى في حالة نجاح استدعاء واجهة برمجة التطبيقات.
{
"المعرف": "101"
}
إجراء طلب PUT باستخدام ملحق عميل REST
تقوم بإجراء طلب PUT عندما تريد تحديث البيانات على الخادم.
لتحديث مورد موجود في JSONPlaceholder API ، استبدل الكود في ملف طلباتي ملف مع ما يلي:
يضع https://jsonplaceholder.typicode.com/posts/1 HTTP / 1.1
نوع المحتوى: "application / json"
{
"العنوان": "new foo"،
"الجسم": "شريط جديد" ،
"معرف المستخدم": 1
}
بعد إرسال الطلب ، سيتم تحديث المورد على الخادم الوهمي وستحصل على ملف HTTP / 1.1 200 موافق رسالة.
إجراء طلب التصحيح باستخدام ملحق عميل REST
تقوم بإجراء طلب التصحيح عندما تريد تعديل حقل أو خاصية معينة لمورد معين على الخادم.
لتحديث عنوان مورد موجود في الخادم الوهمي فقط ، استبدل الكود في ملف طلباتي ملف مع ما يلي:
https://jsonplaceholder.typicode.com/posts/1 HTTP / 1.1
نوع المحتوى: "application / json"
{
"title": "another foo"
}
بعد تقديم الطلب ، سيتم تحديث عنوان المورد على الخادم الوهمي وستحصل على ملف HTTP / 1.1 200 موافق مع البيانات الأخرى للمورد.
إجراء طلب حذف باستخدام ملحق عميل REST
تقوم بإجراء طلب DELETE عندما تريد حذف مورد على الخادم.
لحذف مورد موجود في الخادم الوهمي ، استبدل الكود الموجود في ملف طلباتي ملف مع ما يلي:
يمسح https://jsonplaceholder.typicode.com/posts/1 HTTP / 1.1
هنا ، نوع المحتوى ليس مطلوبًا ، ولا كائن البيانات أيضًا. إذا قمت بإرسال الطلب وحذف المورد بنجاح ، فيجب أن تحصل على ملف HTTP / 1.1 200 موافق استجابة بشيء فارغ.
إجراء مكالمات API مباشرة من داخل رمز VS
في السابق ، ربما تكون قد استخدمت أدوات تابعة لجهات خارجية مثل ساعي البريد لتقديم طلبات API. بينما تؤدي هذه الأدوات المهمة بشكل جيد ، إلا أن إعدادها يستغرق وقتًا. على سبيل المثال ، يجب أن يكون لديك حساب مع Postman لاستخدام مستكشف API.
على الرغم من أن هناك العديد من أدوات اختبار API عبر الإنترنت، ولكن مع امتدادات مثل REST Client ، فإن اختبار واجهات برمجة التطبيقات يكون أسرع وأسهل بكثير. يمكنك اختبار أي API مباشرة من داخل محرر VS Code الخاص بك. هذا مفيد بشكل خاص إذا كنت تقوم بتطوير واجهات برمجة التطبيقات محليًا وترغب في اختبار واجهات برمجة التطبيقات المحلية الخاصة بك بسرعة.
امتدادات رمز API اختبار VS الأخرى
Rest Client سهل الاستخدام. لكنها ليست امتداد VS Code الوحيد لاختبار واجهات برمجة التطبيقات. الخيارات الشائعة الأخرى هي Thunder Client و httpYak و httpBook.
يوفر Thunder Client محررًا مرئيًا لواجهة برمجة التطبيقات لتبسيط طلبات واجهة برمجة التطبيقات. بالطبع ، أنت بحاجة إلى معرفة ماهية REST API لاستخدام هذه الأدوات.
