قبضة، تثبيت Yeoman و generator-expressjs-rest باستخدام npm (نفترض أن لديك Node.js مثبتة مسبقًا).
npm install -g yo
npm install -g generator-expressjs-rest
وبعد ذلك، يمكنك استخدام yo
لإنشاء مشروعك.
yo expressjs-rest # generate a new project
yo expressjs-rest:api # generate a new api endpoint inside your project
بعد إنشاء مشروعك، هذه الأوامر.
cd your-project-name
mv .env.example .env
docker-compose build
docker-compose run --rm client yarn build
docker-compose up
src/
├─ api/
│ ├─ auth/
│ │ ├─ index.js
│ │ ├─ auth.service.js
│ │ ├─ auth.validation.js
│ │ ├─ auth.controller.js
│ │ └─ auth.test.js
│ ├─ uploads/
│ │ ├─ index.js
│ │ ├─ upload.controller.js
│ ├─ users/
│ │ ├─ index.js
│ │ ├─ user.controller.js
│ │ ├─ user.validation.js
│ │ ├─ user.model.js
│ │ ├─ user.service.js
│ │ └─ user.test.js
│ └─ index.js
├─ services/
│ ├─ index.js
│ ├─ jwt.js
│ ├─ logger.js
│ ├─ mailgun.js
│ ├─ mongoose.js
│ ├─ passport.js
│ ├─ response.js
│ ├─ s3.js
│ ├─ swagger.js
│ └─ your-service.js
├─ app.js
├─ config.js
└─ index.js
هنا يتم تحديد نقاط نهاية واجهة برمجة التطبيقات (API). كل واجهة برمجة تطبيقات لها مجلد خاص بها.
وهو يحدد مخطط Mongoose ونموذج نقطة نهاية API. ينبغي إجراء أي تغييرات على نموذج البيانات هنا.
هذا هو ملف وحدة تحكم API. وهو يحدد البرامج الوسيطة لجهاز التوجيه الرئيسي التي تستخدم نموذج واجهة برمجة التطبيقات (API).
هذا هو ملف الإدخال لواجهة برمجة التطبيقات (API). وهو يحدد المسارات التي تستخدم، إلى جانب البرامج الوسيطة الأخرى (مثل الجلسة والتحقق من الصحة وما إلى ذلك)، البرامج الوسيطة المحددة في ملف some-endpoint.controller.js
.
هنا يمكنك وضع helpers
libraries
وأنواع أخرى من الوحدات التي تريد استخدامها في واجهات برمجة التطبيقات الخاصة بك.
العلاقات العامة هي موضع ترحيب.
@minhuyen وجميع المساهمين
معهد ماساتشوستس للتكنولوجيا © مينهوين