استخدام Swashbuckle لإنشاء مستند OpenAPI

  • 3 دقائق

قبل أن يمكن نشر واجهة برمجة تطبيقات الويب إلى Azure API Management باستخدام Visual Studio، يجب أن يكون لها مستند وصف OpenAPI.

يتم استخدام المستند OpenAPI من قبل APIM لاكتشاف نقاط النهاية لواجهة برمجة تطبيقات الويب.

وباستخدام أدوات Swashbuckle، أصبح من الأسهل من أي وقت مضى لمطوري VanArsdel إنشاء وصف OpenAPI لواجهات برمجة التطبيقات على الويب الخاصة بهم.

ما هو OpenAPI وماذا يفعل؟

تحدد وثيقة OpenAPI وصفًا قياسيًا وواجهة غير محددة بلغة البرمجة لواجهات برمجة تطبيقات الويب. يسمح لكل من البشر وأجهزة الكمبيوتر باكتشاف وفهم قدرات الخدمة دون الوصول إلى التعليمات البرمجية المصدر أو الوثائق الإضافية أو فحص حركة مرور الشبكة.

OpenAPI.

وثيقة OpenAPI هي عقد لواجهات برمجة تطبيقات الويب. ويحتاج كل تطبيق مستهلك إلى فهم واجهات برمجة تطبيقات الويب والتواصل معها، دون الحاجة إلى معرفة مكان وجود واجهات برمجة التطبيقات أو ما إذا كانت قيد التشغيل.

إنشاء مستند OpenAPI من تطبيق ASP.NET Core web API

هناك عدة طرق لإنشاء مستند OpenAPI من تطبيق API ASP.NET Core Web. Swashbuckle هي الطريقة الأكثر شعبية للقيام بذلك.

Swashbuckle.

إنه سهل الاستخدام، وبمجرد تثبيته على تطبيقك، يعرض تلقائيًا شاشة واجهة مستخدم Swagger.

Swagger UI.

يقوم Swashbuckle أيضا بإنشاء مستند OpenAPI أثناء التنقل، والذي يتضمن جميع تفاصيل نقطة نهاية واجهة برمجة التطبيقات وهياكل البيانات الأساسية ومتطلبات الأمان وما إلى ذلك. فيما يلي نموذج المستند لواجهة برمجة تطبيقات الويب لإدارة المخزون الخاصة ب VanArsdel.

OpenAPI Document.

في الوحدة التالية، سيوضح لك التمرين كيفية تمكين إمكانية OpenAPI هذه لتطبيق ASP.NET Core Web API.