0Pricing
TypeScript Academy · درس

توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا

ولّدوا أنواع TypeScript من مواصفات OpenAPI

توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا درس مجاني في TypeScript Academy على CoddyKit. هذا هو الدرس 3 من أصل 4. يمكنك قراءة الدرس كاملاً أدناه مجاناً — ثم تمرن عليه مباشرة في المتصفح باستخدام محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7. هذا الدرس جزء من مسار التعلم في TypeScript Academy، وتقدمك يتزامن عبر الويب وتطبيق CoddyKit. تتضمن دورة TypeScript Academy 4 دروس في المجموع.

مرحبًا

ينشئ OpenAPI codegen أنواع TypeScript وشيفرة العميل من مواصفات API، مما يلغي الحاجة إلى صيانة الأنواع يدويًا.

لماذا Codegen

تُعد كتابة الأنواع يدويًا لواجهات API الكبيرة عرضةً للأخطاء وقد تصبح غير متزامنة. يستمد Codegen الأنواع من المصدر الوحيد للحقيقة: مواصفة OpenAPI.

openapi-typescript

ينشئ openapi-typescript أنواع TypeScript من ملف مواصفة OpenAPI.
npm install -D openapi-typescript
npx openapi-typescript ./api.yaml -o ./src/types/api.ts

الأنواع المُنشأة

تنشئ الأداة أنواع المسارات والعمليات والمخططات.
import type { paths } from './types/api';
type GetUserResponse = paths['/users/{id}']['get']['responses']['200']['content']['application/json'];

عميل openapi-fetch

استخدم openapi-fetch مع الأنواع المُنشأة للحصول على عميل محدد النوع بالكامل.
import createClient from 'openapi-fetch';
const client = createClient<paths>({ baseUrl: 'https://api.example.com' });
const { data, error } = await client.GET('/users/{id}', { params: { path: { id: 1 } } });

Swagger Codegen

ينشئ Swagger Codegen حزم SDK كاملة للعميل باستخدام TypeScript.
npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate -i api.yaml -g typescript-axios -o ./src/client

orval

ينشئ orval خطافات React Query ومخططات Zod من مواصفات OpenAPI.
npm install -D orval
orval --input api.yaml --output src/api

الحفاظ على تزامن الأنواع

شغّل codegen في CI لاكتشاف الاختلاف بين المواصفة والأنواع المُنشأة.

تطوير API انطلاقًا من المخطط

عرّف مواصفة OpenAPI أولًا، ثم أنشئ الأنواع وشيفرة العميل، وبعد ذلك نفّذ الخادم.

MSW مع الأنواع المُنشأة

استخدم Mock Service Worker مع الأنواع المُنشأة لمحاكاة API آمنة من ناحية الأنواع في الاختبارات.

إنشاء عناوين URL آمنة من ناحية الأنواع

يفرض العملاء المُنشأون استخدام معاملات المسار وبُنى سلاسل الاستعلام الصحيحة.

تحقق سريع

ما الفائدة الأساسية من استخدام OpenAPI TypeScript codegen؟

مراجعة

OpenAPI Codegen: الأنواع المُنشأة تلقائيًا: أتقنتم المفاهيم والأنماط الأساسية.

الأسئلة الشائعة

هل درس «توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا» مجاني؟

نعم — نص درس «توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا» كامل متاح مجاناً هنا على الويب. لتمرينه بشكل تفاعلي (محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7) وفتح باقي دورة TypeScript Academy، انتقل إلى CoddyKit PRO. تتضمن دورة TypeScript Academy 4 دروس في المجموع.

ماذا ستتعلم في «توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا»؟

ولّدوا أنواع TypeScript من مواصفات OpenAPI تتمرن على TypeScript Academy مع أكواد عملية تشغلها مباشرة في المتصفح، ومدرس ذكاء اصطناعي متاح 24/7 يجيب على أسئلتك أثناء عملك.

هل أحتاج إلى خبرة سابقة لأبدأ TypeScript Academy؟

لا تُشترط خبرة سابقة. TypeScript Academy على CoddyKit منظم للمبتدئين حتى المتقدمين، لذا يمكنك البدء من هنا أو من البداية والتقدم بسرعتك الخاصة. هذا هو الدرس 3 من أصل 4.

كم من الوقت يستغرق درس «توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا»؟

معظم دروس CoddyKit تستغرق حوالي 5–10 دقائق. كل منها موجز وتفاعلي، لذا تحرز تقدماً مستمراً وتستأنف من حيث توقفت عبر الويب والتطبيق.

هل يمكنني كتابة وتشغيل أكواد في درس TypeScript Academy هذا؟

نعم. كل درس في TypeScript Academy يتضمن محرر أكواد مدمج، لذا تكتب وتشغل أكواداً حقيقية مباشرة في متصفحك وتحصل على تعليقات فورية من الذكاء الاصطناعي — بدون إعداد محلي.

جميع الدروس في هذه الدورة

  1. تحديد أنواع استجابات Fetch باستخدام أغلفة عامة
  2. التحقق وقت التشغيل باستخدام Zod
  3. توليد شيفرة OpenAPI: أنواع مولّدة تلقائيًا
  4. نظرة عامة على عميل tRPC الآمن من ناحية الأنواع
← العودة إلى TypeScript Academy