กำปั้น ติดตั้ง 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 แต่ละ API มีโฟลเดอร์ของตัวเอง
โดยกำหนดสคีมา Mongoose และโมเดลสำหรับจุดสิ้นสุด API การเปลี่ยนแปลงใดๆ กับโมเดลข้อมูลควรทำที่นี่
นี่คือไฟล์ตัวควบคุม API มันกำหนดมิดเดิลแวร์เราเตอร์หลักซึ่งใช้โมเดล API
นี่คือไฟล์รายการของ API โดยกำหนดเส้นทางโดยใช้มิดเดิลแวร์อื่นๆ (เช่น เซสชัน การตรวจสอบ ฯลฯ) มิดเดิลแวร์ที่กำหนดในไฟล์ some-endpoint.controller.js
ที่นี่คุณสามารถใส่ helpers
, libraries
และโมดูลประเภทอื่นๆ ที่คุณต้องการใช้ใน API ของคุณ
ยินดีประชาสัมพันธ์ครับ.
@minhuyen และผู้สนับสนุนทุกท่าน
MIT © minhuyen