تخطَّ إلى المحتوى الرئيسي

مواصفة OpenAPI

OpenAPI هي المواصفة القياسية في القطاع لوصف واجهات REST بصيغة قابلة للقراءة الآلية (YAML أو JSON). وتحدد وثيقة OpenAPI نقاط نهاية الواجهة، ومخططات الطلبات والاستجابات، والمعاملات، وأنواع البيانات، وأنظمة المصادقة، وإدارة الإصدارات — أي أنها عقد كامل ومهيكل لسلوك الواجهة. ويمكن للأدوات توليد التوثيق وشيفرة العملاء وخوادم المحاكاة واختبارات التحقق مباشرةً من المواصفة.

وبالنسبة لفرق حوكمة البيانات، تكمن قيمة OpenAPI فيما يكشفه المخطط؛ فلأن كل حقل في الاستجابة يُعلن باسمه ونوعه، تُعد وثيقة OpenAPI بحد ذاتها بيانات وصفية: فهي تخبرك بدقة بعناصر البيانات التي تعرضها الواجهة. وهذا يجعل من الممكن استيعاب مواصفات الواجهات في كتالوج البيانات بالطريقة نفسها التي تُجمع بها مخططات الجداول من قواعد البيانات — آلياً وبشكل قابل للتكرار.

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

في المنتج