يتيح لك عنوان URL أساسي في Apidog استخلاص الجزء المتكرر من عناوين نقاط النهاية الخاصة بك للإدارة الموحدة.
على سبيل المثال، إذا كانت نقطة النهاية الخاصة بك هي https://api.example.com/v1/users، فيمكنك تعيين https://api.example.com/v1 كعنوان URL أساسي. ثم في تعريف نقطة النهاية الخاصة بك، ما عليك سوى كتابة /users.
عند إرسال طلب، سيقوم Apidog تلقائيًا بربط عنوان URL الأساسي ومسار نقطة النهاية لتشكيل عنوان الطلب الكامل. الفائدة هي أنه إذا تغير عنوان الخادم، ما عليك سوى تحديث عنوان URL الأساسي — لا حاجة لتعديل كل نقطة نهاية على حدة.
خطوات لتعيين عنوان URL أساسي
افتح مشروع Apidog الخاص بك وابحث عن "إدارة البيئة" في الزاوية العلوية اليمنى. سيقوم Apidog بإنشاء العديد من البيئات الشائعة افتراضيًا، مثل التطوير والاختبار والإنتاج. يمكنك استخدام هذه الإعدادات المسبقة أو إنشاء بيئات جديدة حسب الحاجة.
بعد تحديد بيئة، سترى مربع إدخال "عنوان URL الأساسي". أدخل العنوان الأساسي الذي يبدأ بالبروتوكول (http:// أو https://)، مثل https://test.server.com، أو قم بتضمين رقم إصدار مثل https://api.example.com/v1.
تأكد من عدم إضافة شرطة مائلة في النهاية. وفقًا لمواصفات OpenAPI، يجب ألا ينتهي عنوان URL الأساسي بـ /، بينما يجب أن يبدأ مسار نقطة النهاية بـ /.
نوصي باتباع مواصفات OpenAPI للحصول على توافق أفضل وتجربة ميزات أكثر اكتمالاً في Apidog.
استخدام عنوان URL الأساسي في نقاط النهاية
الآن، عند إنشاء نقطة نهاية جديدة، ما عليك سوى إدخال مسار نقطة النهاية في حقل URL. على سبيل المثال، لاختبار نقطة نهاية قائمة المستخدمين، ما عليك سوى إدخال /users، وسيجمعها Apidog تلقائيًا في عنوان URL الكامل للطلب https://api.example.com/v1/users.
إذا كان مسار نقطة النهاية الخاص بك يتضمن مستويات متعددة، مثل /users/123/profile، يمكنك اتباع نفس الطريقة — سيقوم Apidog تلقائيًا بدمج عنوان URL الأساسي مع المسار الخاص بك لتشكيل عنوان URL الكامل للطلب.
ملاحظة: إذا أدخلت عنوانًا كاملاً (يبدأ بـ http:// أو https://) في عنوان URL لنقطة النهاية، فلن يتم استخدام عنوان URL الأساسي. سيعطي Apidog الأولوية للعنوان الكامل الذي تقدمه.
إدارة عناوين URL الأساسية عبر بيئات متعددة
تحتوي معظم المشاريع على بيئات متعددة (تطوير، اختبار، إنتاج)، لكل منها عنوان خادم مختلف. يمكنك تعيين عنوان URL أساسي مختلف لكل بيئة.
على سبيل المثال:
- التطوير:
https://dev-api.example.com/v1 - الاختبار:
https://test-api.example.com/v1 - الإنتاج:
https://api.example.com/v1
عند تبديل البيئات من الزاوية العلوية اليمنى، ستستخدم جميع نقاط النهاية تلقائيًا عنوان الخادم للبيئة المحددة.
يمكنك أيضًا اختيار البيئة مباشرة في شريط عنوان نقطة النهاية، حيث يتم عرض عنوان URL الأساسي الافتراضي لكل بيئة. يعمل هذا بنفس طريقة تبديل البيئات في لوحة "إدارة البيئة".
ملاحظة: إذا كانت البيئة تحتوي على عناوين URL أساسية متعددة، فسيظهر العنوان الافتراضي فقط في شريط العنوان. لاستخدام عنوان URL أساسي غير افتراضي لنقاط نهاية محددة، ستحتاج إما إلى تعيينه يدويًا داخل نقطة النهاية أو إدارته من خلال الوحدات النمطية.
يُعد إعداد عناوين URL الأساسية المتعددة هذا شائعًا في بنى الخدمات المصغرة، حيث تحتاج نقاط النهاية المختلفة إلى استخدام عناوين خدمة مختلفة.
إدارة عناوين URL الأساسية في الخدمات المصغرة
إذا كان مشروعك يستخدم بنية الخدمات المصغرة وليست جميع نقاط النهاية تشترك في نفس عنوان URL الأساسي، فلديك طريقتان لإدارة عناوين URL الأساسية في Apidog.
تحديد عناوين URL الأساسية يدويًا داخل وحدة نمطية
يمكنك تجميع نقاط النهاية من خدمات مختلفة في وحدة نمطية واحدة وتعيين عناوين URL أساسية مختلفة لمجلدات معينة أو نقاط نهاية فردية. هذا الإعداد مرن ويعمل بشكل جيد للفرق التي تفضل الإدارة المركزية.
على سبيل المثال، يمكنك تكوين وحدة نمطية بها عناوين URL أساسية متعددة لخدمات مختلفة.
ثم، قم بتعيين عنوان URL الأساسي "خدمة المستخدم" لمجلد المستخدم وعنوان URL الأساسي "خدمة الطلبات" لمجلد الطلبات. ستستخدم جميع نقاط النهاية داخل كل مجلد عنوان URL الأساسي المقابل تلقائيًا.
إذا كنت لا ترغب في التكوين حسب المجلد، يمكنك أيضًا تعيين عنوان URL الأساسي لنقاط النهاية الفردية. ما عليك سوى فتح صفحة "تعديل" نقطة النهاية وتحديد عنوان URL الأساسي المطلوب من القائمة المنسدلة.
ومع ذلك، مع زيادة عدد الخدمات، يمكن أن تصبح إدارة عناوين URL الأساسية بهذه الطريقة مملة وأصعب في الصيانة. قد تعمل بشكل جيد للمشاريع الصغيرة، ولكن المشاريع الكبيرة يمكن أن تصبح صعبة الإدارة بسرعة.
لتحقيق قابلية توسع ووضوح أفضل، نوصي باتباع نهج أكثر تنظيمًا:
فصل كل خدمة في وحدة نمطية خاصة بها وتعيين عنوان URL الأساسي على مستوى الوحدة النمطية. هذا يحافظ على مشروعك منظمًا وأسهل بكثير في الصيانة.
تنظيم الخدمات حسب الوحدة النمطية (موصى به)
قم بإنشاء وحدة نمطية منفصلة لكل خدمة وقم بتكوين عنوان URL الأساسي الخاص بها ضمن "إدارة البيئة" لكل بيئة. هذا النهج أكثر تنظيمًا ومثاليًا للتعاون الجماعي والصيانة طويلة الأجل.
على سبيل المثال، يمكنك إنشاء وحدات نمطية منفصلة لـ خدمة المستخدم، وخدمة الطلبات، وخدمة المنتجات، وكل منها مرتبط بملف Swagger أو OpenAPI الخاص به.
بمجرد إعداد الوحدات النمطية، انتقل إلى صفحة "إدارة البيئة"، حيث سترى إعدادات عنوان URL الأساسي مجمعة بشكل أنيق حسب الوحدة النمطية.
تتشارك كل بيئة نفس بنية الوحدة النمطية، ولكن عنوان URL الأساسي لكل وحدة نمطية يمكن أن يختلف حسب البيئة. يتيح لك هذا تعيين عناوين URL أساسية محددة لكل وحدة نمطية في كل بيئة. على سبيل المثال:
| البيئة | خدمة المنتجات | خدمة المستخدم | خدمة الطلبات |
|---|---|---|---|
| الإنتاج | https://product.example.com | https://user.example.com | https://order.example.com |
| الاختبار | http://192.168.1.10:8080 | http://192.168.1.11:8080 | http://192.168.1.12:8080 |
| التطوير | http://localhost:3000 | http://localhost:3001 | http://localhost:3002 |
مع هذا الإعداد، كلما أنشأت نقطة نهاية جديدة داخل وحدة نمطية، ستستخدم تلقائيًا عنوان URL الأساسي الصحيح للبيئة الحالية — لا حاجة لتحديده يدويًا. على سبيل المثال:
- في "وحدة خدمة المستخدم وبيئة الإنتاج"، عنوان URL الأساسي الافتراضي هو
https://user.example.com. - في "وحدة خدمة الطلبات وبيئة الاختبار"، هو
http://192.168.1.12:8080.
فكر في اقتران "الوحدة النمطية + البيئة" كنظام إحداثيات يحدد بدقة عنوان URL للطلب. طالما أن وحداتك النمطية وبيئاتك منظمة بشكل صحيح، سيختار Apidog تلقائيًا عنوان URL الأساسي الصحيح لكل طلب.
لن تضطر إلى التساؤل، "ما هو العنوان الذي تستخدمه نقطة النهاية هذه؟" — ما عليك سوى تحديد الوحدة النمطية والبيئة المناسبتين، ويتولى Apidog الباقي.اسأل ChatGPT
نصائح عملية لاستخدام عناوين URL الأساسية
- إذا كان واجهة برمجة التطبيقات (API) الخاص بك يتضمن رقم إصدار، فأضفه مباشرة إلى عنوان URL الأساسي — على سبيل المثال:
https://api.example.com/v2. بهذه الطريقة، عند ترقية إصدار واجهة برمجة التطبيقات، ما عليك سوى تحديث عنوان URL الأساسي، وليس كل نقطة نهاية. - للحالات الخاصة، مثل استدعاء خدمات الطرف الثالث، يمكنك إدخال عنوان URL الكامل مباشرة في نقطة النهاية. سيتجاوز هذا عنوان URL الأساسي الافتراضي تلقائيًا.
الخاتمة
تعد إدارة عناوين URL الأساسية بفعالية أمرًا أساسيًا للحفاظ على مشاريع واجهة برمجة التطبيقات نظيفة وقابلة للتوسع وسهلة الصيانة — خاصة مع ازدياد تعقيدها. سواء كنت تعمل على مشروع بسيط ذي خدمة واحدة أو بنية خدمات مصغرة كبيرة، يقدم Apidog خيارات مرنة تتكيف مع سير عملك.
من خلال تنظيم خدماتك في وحدات نمطية وتكوين عناوين URL الأساسية لكل بيئة، فإنك تضمن أن كل نقطة نهاية تشير دائمًا إلى الخادم الصحيح — دون الحاجة إلى تدخل يدوي. بفضل الإعدادات الافتراضية الذكية، وتبديل البيئات، والتصميم المعياري، يبسط Apidog العملية ويزيل التخمين.