Primero, instale Yeoman y generador-expressjs-rest usando npm (asumimos que tiene node.js preinstalado).
npm install -g yo
npm install -g generator-expressjs-rest
Luego, puedes usar yo
para generar tu proyecto.
yo expressjs-rest # generate a new project
yo expressjs-rest:api # generate a new api endpoint inside your project
Después de generar su proyecto, estos comandos.
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
Aquí es donde se definen los puntos finales de la API. Cada API tiene su propia carpeta.
Define el esquema y modelo de Mongoose para el punto final de API. Cualquier cambio en el modelo de datos debe realizarse aquí.
Este es el archivo del controlador API. Define los principales middlewares de enrutador que utilizan el modelo API.
Este es el archivo de entrada de la API. Define las rutas utilizando, junto con otros middlewares (como sesión, validación, etc.), los middlewares definidos en el archivo some-endpoint.controller.js
.
Aquí puede colocar helpers
, libraries
y otros tipos de módulos que desee utilizar en sus API.
Los RP son bienvenidos.
@minhuyen y todos los contribuyentes
MIT © minhuyen