واجهة REST البرمجية
يوفّر EntityFlow واجهة REST عامة خفيفة ومُصدَّرة بإصدارات مُركَّبة على المسار /api/v1. وهي تطبّق نفس عمليات التحقق من الأذونات المحدودة بنطاق المستأجر التي يطبّقها التطبيق، فأي إجراء لا يمكنك تنفيذه في الواجهة لن تتمكن من تنفيذه عبر واجهة API.
المصادقة
أرسِل ترويسة Authorization: Bearer <token>. والرمز المميّز هو إما:
- رمز جلسة مميّز، أو
- مفتاح API (
ef_live_...) — راجع مفاتيح API.
curl https://<your-host>/api/v1/diagrams \
-H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"
نقاط النهاية
| الطريقة والمسار | الغرض |
|---|---|
GET /api/v1/diagrams | سرد المخططات. |
POST /api/v1/diagrams | إنشاء مخطط. |
GET /api/v1/diagrams/{id} | جلب مخطط واحد. |
PUT /api/v1/diagrams/{id} | حفظ (تحديث) مخطط. |
DELETE /api/v1/diagrams/{id} | حذف مخطط. |
POST /api/v1/diagrams/{id}/export | تصدير SQL أو DBML. |
GET /api/v1/catalog/tables | البحث عن الجداول عبر المخططات. |
/api/v1/keys | إدارة مفاتيح API. |
/api/v1/webhooks | إدارة webhooks. |
OpenAPI والتوثيق التفاعلي
| المورد | URL |
|---|---|
| مواصفة OpenAPI | /api/v1/openapi.json |
| التوثيق التفاعلي | /api/v1/docs |
استخدم مستند OpenAPI لتوليد عملاء باللغة التي تختارها، واستخدم التوثيق التفاعلي لاستكشاف الطلبات مباشرةً.
ملاحظة
واجهة REST مُصدَّرة بإصدارات بشكل مستقل. وتشير زيادة الإصدار الرئيسي (على سبيل المثال، /api/v2) إلى تغييرات قد تكسر التوافق؛ أما ضمن الإصدار الرئيسي الواحد فتكون التغييرات إضافية ومتوافقة مع الإصدارات السابقة.