انشر أول واجهة برمجة تطبيقات

يأخذ هذا الدليل التعليمي واجهة برمجة تطبيقات بناها فريقك ويُدخلها في الكتالوج، مملوكة لفريقك، ليتمكن المستهلكون من اكتشافها وقراءة مواصفتها والاشتراك بتطبيقاتهم فيها.

قبل أن تبدأ، تحتاج إلى:

• حساب API-dex بدور CI/CD للتحميل، وعضوية في فريق خلفية لخطوة الملكية. راجع الأدوار وأنواع المستخدمين إن لم تكن متأكدًا.
• ملف مواصفة OpenAPI الخاص بالواجهة.
• فريق خلفية للواجهة. إن لم يكن موجودًا بعد، فأنشئه أولًا: راجع إدارة فرقك.

انشر الواجهة

1

سجّل الدخول

افتح عنوان API-dex الخاص بك وسجّل الدخول بحساب مؤسستك. ستصل إلى الصفحة الرئيسية.

2

اختر البيئة

افتح عنصر التحكم بالبيئة في الشريط العلوي واختر البيئة التي نُشرت واجهتك عليها. التحميل ومدخل الكتالوج مقيّدان بهذه البيئة. راجع البيئات.

3

افتح APIs

افتح APIs من التنقّل الرئيسي لفتح كتالوج البيئة المحددة.

4

حمّل المواصفة

بحساب CI/CD، أسقط ملف المواصفة على منطقة التحميل في صفحة APIs، أو اختره للاستعراض. من خط الأنابيب، شغّل apidex-cli upload-spec بدلًا من ذلك. تتحقق API-dex من الملف وتُبلّغ عن خطأ مقروء إن لم تكن المواصفة OpenAPI صالحة.

5

عيّنها لفريقك

افتح الواجهة الجديدة، وافتح قائمة الصفحة بجانب العنوان، واختر Assign to backend team، ثم اختر فريقك. الملكية هي ما يُخبر المستهلكين بمن يتصلون للتغييرات والحوادث.

6

تحقق من وجودها في الكتالوج

ارجع إلى APIs. واجهتك مدرجة لهذه البيئة، ومواصفتها قابلة للعرض، وفريقك معروض بوصفه المالك.

لم يُطلق بعد

يُشحن التحميل من المتصفح عبر صفحة Upload spec ذات الخطوات الأربع، بما في ذلك طبقات الترجمة، في إصدار بعد API-dex 3.1.0. راجع سجلّ التغييرات.

INFO

أصبحت واجهتك الآن قابلة للاكتشاف. يفتحها المستهلكون من APIs، ويقرؤون المواصفة، ويضيفونها إلى أحد تطبيقاتهم. ذلك هو الدليل التالي: استهلك أول واجهة برمجة تطبيقات.

ما التالي

• عرض واجهة برمجة التطبيقات الخاصة بك: النسخة المختصرة من هذه الخطوات للمرة القادمة.
• إدارة فرقك: أضف زملاءك إلى فريق الخلفية.
• المرجع: كتالوج واجهات برمجة التطبيقات: كل عنصر تحكم في صفحة الواجهة، بما في ذلك مقارنة الإصدارات.