هذه ترجمة للصفحة الأصلية بالإنجليزية. عند وجود أي اختلاف، تُعتمد النسخة الإنجليزية.
درس تعليمي: ابنِ واجهة برمجة لمكتبة كتب
سنبني من البداية إلى النهاية خدمة صغيرة لمكتبة كتب: المسارات، والتحقق، والأمان، وOpenAPI، وSDK مكتوب الأنواع مع Hey API، واختبارات العقود. في النهاية سيكون لديك تطبيق DaloyJS بهيئة جاهزة للإنتاج.
- 01إنشاء المشروعpnpm add @daloyjs/core zod
- 02مصنع buildAppالمسارات · Zod · خطّافات الأمان
- 03التشغيلserve(app) على Node
- 04مواصفة OpenAPIgenerateOpenAPI(app)
- 05SDK مكتوب الأنواعHey API openapi-ts
- 06اختبارات العقودrunContractTests(app)
1. أنشئ المشروع
2. ابنِ مصنع buildApp مشتركًا
شارك الـ App بين الخادم وتوليد الشيفرة والاختبارات لتبقى المواصفة والعميل والاختبارات متوافقة:
3. شغّل الخادم
4. ولّد مواصفة OpenAPI
5. ولّد SDK مكتوب الأنواع مع Hey API
6. استخدم الـ SDK من أي مستهلك TS
7. أضف الاختبارات
ما الذي بنيته
- واجهة HTTP مكتوبة الأنواع ومُتحقَّق منها ومحمية.
- مستند OpenAPI 3.1 حقيقي وSDK مكتوب الأنواع مولَّد، يبقيان متزامنين.
- اختبارات عقود تحرس من التباين في التكامل المستمر.
- مسار تثبيت معزَّز باستخدام pnpm وملف
.npmrcمحكم.
تابع مع الأمان، ثم درس التفويض متعدد المستخدمين، وAdapters، ومرجع الواجهة البرمجية، وهذه الثلاثة بالإنجليزية.
آخر تحديث: