تخطَّ إلى المحتوى

أدوات API

تضم فئة API ثلاث أدوات لقراءة تعريفات واجهات API وإعداد الطلبات. ولا ترسل أي منها طلبًا.

المسار: /tools/api/swagger

محرر وعارض توثيق لتعريفات OpenAPI 3.x وSwagger 2.0 المكتوبة بصيغة YAML أو JSON.

  • افتح ملفًا أو حرر التعريف في المحرر، مع الطي والبسط، والبحث، وعرض المسافات البيضاء، واقتراحات للمفاتيح والقيم.
  • لوحة Documentation مع بحث في العمليات وأداة Expand all.
  • يملأ Generate samples كل عملية مدرجة بعينة جديدة.
  • حوّل المستند نفسه بين YAML وJSON.
  • يحوّل Docs as Markdown التوثيق إلى Markdown يمكنك نسخه أو تنزيله أو فتحه في محرر Markdown.
  • خيارات للتخطيط: المحرر مع التوثيق، أو العارض فقط.
  • سطر cURL المعروض لعملية ما أمر تشغّله أنت بنفسك.

المسار: /tools/api/http-headers

مرجع ومجموعة من أدوات البناء لترويسات HTTP، في قسمين: All headers وMedia types.

  • ابحث في الترويسات بالاسم أو الوصف أو المثال، وصفِّها حسب الفئة وحسب الاتجاه (ترويسات الطلب، أو ترويسات الاستجابة، أو كليهما).
  • جدول لأنواع الوسائط (media types) قابل للبحث بالنوع أو الامتداد أو الملاحظة، مع بحث باسم الملف أو الامتداد.
  • منشئ Content-Type يتعامل مع ترميز المحارف (charset) وحد multipart (boundary).
  • منشئ ترويسة Accept مع الترتيب بـ ‎q.
  • شرح لـ Content-Encoding وAccept-Encoding، وقائمة بما لا يستحق الضغط.
  • منشئا Cache-Control وContent-Disposition. يتعامل منشئ Content-Disposition مع أسماء الملفات غير ASCII بـ ‎filename*=UTF-8'' مع بديل ASCII.
  • لكل منشئ زر Copy.

المسار: /tools/api/api-composer

ينشئ طلب HTTP ويولّد أمر curl. لا يرسل الطلب؛ وتذكر الصفحة أنك تشغّل curl بنفسك.

  • حدّد الطريقة وعنوان URL، مع عناصر نائبة بصيغة ‎{{variable}}، واملأ Params وHeaders وAuth وBody وOptions وVariables.
  • اطّلع على أمر curl المولَّد وانسخه.
  • استورد أمر curl واقرأه في النموذج.
  • احفظ الطلبات في مجموعة اسمها My requests، وأعد تسمية المجموعة، وصدّرها بوصفها ملف JSON أو افتح واحدة.
  • عند حفظ الطلبات في هذا المتصفح أو تصديرها، يمكن إفراغ كلمات المرور والرموز (tokens) ومفاتيح API وترويسات Authorization أو إبقاؤها، حسب اختيارك.