تبسيط ملفات OpenAPI الخاصة بك باستخدام OpenAPI Trimmer

يمكن أن تكون إدارة ملفات OpenAPI الكبيرة أمرًا صعبًا، خاصة عندما تحتاج فقط إلى جزء صغير من واجهة برمجة التطبيقات لمهام محددة. هذا هو المكان الذي يكون فيه OpenAPI Trimmer مفيدًا. إنها أداة خفيفة الوزن مصممة لتقليص ملفات OpenAPI الخاصة بك لتشمل فقط نقاط النهاية وكائنات نقل البيانات (DTOs) التي تهمك.

كيف يعمل؟

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

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

هذا الأمر سوف:

• -i openapi.yaml: استخدم ملف OpenAPI YAML الحالي كمدخل.
• -p /v1/quotes,/v1/users: احتفظ فقط بنقاط النهاية التي تبدأ بـ /v1/quotes و/v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: استبعاد مكونات محددة، في هذه الحالة، CompanyConfigDto، وUpdateCompanyConfigDto.

سيتم حفظ تعريف واجهة برمجة التطبيقات (API) المشذبة باسم openapi-trimmer.yaml.

تصديق

لضمان سلامة ملف OpenAPI الذي تم اقتطاعه، قم بالتحقق من صحته باستخدام:

swagger-cli validate ./openapi-trimmer.yaml

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

تثبيت

يمكنك تثبيت OpenAPI Trimmer مباشرة من PyPi:

pip install openapi-trimmer

لمزيد من التفاصيل وآخر التحديثات، قم بزيارة صفحة OpenAPI Trimmer PyPi.

مستودع GitHub: OpenAPI Trimmer على GitHub.

خيارات سطر الأوامر

يوفر OpenAPI Trimmer عدة خيارات لتخصيص تشغيله:

• -h, --help: عرض معلومات المساعدة.
• -v, --version: عرض رقم الإصدار.
• -i INPUT, --input INPUT: حدد ملف الإدخال YAML (مطلوب).
• -o OUTPUT, --output OUTPUT: تحديد اسم ملف الإخراج (اختياري؛ الإعدادات الافتراضية هي إلحاق "-trimmed" بملف الإدخال).
• -p PREFIXES, --prefixes PREFIXES: قم بإدراج المسارات التي سيتم الاحتفاظ بها في الإخراج (مفصولة بفواصل).
• -ec EXCLUDE_COMPONENTS، --exclude-components EXCLUDE_COMPONENTS: قم بإدراج المكونات المراد استبعادها (مفصولة بفواصل).

خاتمة

تعد أداة OpenAPI Trimmer أداة أساسية للمطورين الذين يتطلعون إلى تبسيط ملفات OpenAPI الخاصة بهم، مما يجعلها أكثر قابلية للإدارة ومخصصة لتلبية احتياجات محددة. سواء كنت تقوم بإعداد وثائق واجهة برمجة التطبيقات (API) أو تبسيط واجهة برمجة التطبيقات (API) للاستخدام الداخلي، فإن OpenAPI Trimmer يوفر لك الوقت والجهد من خلال التركيز فقط على ما يهمك أكثر.