تاريخ النشر: Dec 1, 2016
يمكنك الآن إضافة الوثائق إلى طرقك ومواردك الخاصة بواجهات برمجة تطبيقاتك المصممة باستخدام Amazon API Gateway، ما يسهّل على مستهلكي واجهات تطبيقاتك فهم هذه الواجهات. وبوسعك إضافة الوثائق إلى واجهة برمجة تطبيقاتك مباشرة باستخدام وحدة التحكم ببوابة واجهة برمجة التطبيقات وواجهة سطر الأوامر (CLI) وحزمة أدوات تطوير البرمجيات (SDK) أو ببساطة تحديدها باستخدام علامات الوثائق ضمن تعريف Swagger لواجهة برمجة التطبيقات. يمكنك أيضًا إعادة استخدام الوثائق عبر الجوانب المشتركة لواجهة برمجة تطبيقاتك. على سبيل المثال، يمكنك كتابة وثائق خطأ قياسية مرة واحدة فقط واستخدامها في العديد من استجابات واجهات برمجة التطبيقات بدون تكرار المحتوى الفعلي، ما يسرّع من توثيق واجهات برمجة التطبيقات والتخلّص من أخطاء «النسخ-اللصق» التي قد تنشأ في السطور المكررة. وحالما تُنشر وثائقك بمثابة جزء من مرحلة واجهة برمجة التطبيقات، يمكنك تصديرها باستخدام سمة التصدير في Swagger وإتاحتها في بوابة المطورين لديك.
توفّر بوابة واجهة برمجة التطبيقات لك مسارات عمل مستقلة لتعريف واجهة برمجة التطبيقات وتوثيق واجهة برمجة التطبيقات. يمكّن ذلك مطوري واجهات برمجة التطبيقات والكتّاب التقنيين من العمل على التوازي واستيراد Swagger خاصّتهم بشكل منفصل باستخدام وحدة التحكم وواجهة سطر الأوامر (CLI) وحزمة أدوات تطوير البرمجيات (SDK).
لمزيد من المعلومات، اطّلع على توثيق واجهة برمجة تطبيقات في بوابة واجهة برمجة التطبيقات.