OpenAPI إلى TypeScript
أنشئ أنواع TypeScript من مخططات مستند OpenAPI 3 أو Swagger 2.0 بصيغة YAML أو JSON. يتحول كل إدخال ضمن components.schemas، أو ضمن definitions في Swagger 2.0، إلى واجهة مُصدّرة أو اسم مستعار لنوع. وتتحول الروابط $ref بينها إلى أسماء أنواع، وتُضاف | null إلى الحقول القابلة لأن تكون null.
الأسئلة الشائعة
ما أجزاء المستند التي يجري تحويلها؟
المخططات ضمن components.schemas في OpenAPI 3 وضمن definitions في Swagger 2.0. لا تتحول المسارات والمعاملات والاستجابات إلى أنواع؛ استخدم أنواع المخططات المُنشأة في كود الطلبات والاستجابات الخاص بك.
كيف تتحول أسماء المخططات إلى أسماء أنواع؟
تُعاد صياغة كل مفتاح مخطط باستخدام PascalCase؛ مثلًا، يتحول user-profile إلى UserProfile. وعندما ينتج عن مفتاحين الاسم نفسه، يُضاف رقم إلى الاسم الثاني.
هل الحقول القابلة لأن تكون null مدعومة؟
نعم. تضيف nullable: true في OpenAPI 3.0 وx-nullable: true في Swagger 2.0 القيمة | null، كما تتحول مصفوفات الأنواع في OpenAPI 3.1 مثل ["string", "null"] إلى string | null.
ماذا يحدث للمراجع التي لا تستطيع الأداة حلها؟
يتحول $ref الذي يشير إلى خارج المستند، أو إلى عنصر غير مخطط ضمن components.schemas أو definitions، إلى unknown ويُدرج في تعليق أعلى المخرجات.
هل YAML مدعوم؟
نعم. ألصق المستند بصيغة YAML أو JSON. وتُوسّع المراسي والأسماء المستعارة في YAML قبل التحويل.
كيف أتحقق من المستند أولًا؟
استخدم مدقّق OpenAPI، الذي يسرد المشكلات البنيوية والمراجع المعطوبة. يقرأ هذا المحوّل المخططات فقط ولا يبلغ عن الأخطاء الأخرى.