REST API CRUD NodeJS, typescript, mongo, express with 2 commands.

thesuperankes — Tue, 05 Oct 2021 13:32:47 +0000

SuperApiBoost is a client who seeks to improve development times.

In this post I will show you how to make a complete api under NodeJs with Typescript, Mongo and Express with just two commands an a file.

First thing they need to do is install the client with npm.

npm i -g superapiboost

To generate the project you must execute the "new" command with the -n flag to assign the name

sabo new -n=Awesome

This will create a root folder with the name of the project and install the dependencies.

📦Awesome
 ┣ 📂node_modules
 ┣ 📂src
 ┃ ┣ 📂api
 ┃ ┃ ┣ 📂routes
 ┃ ┃ ┗ 📜index.ts
 ┃ ┣ 📂controllers
 ┃ ┃ ┗ 📜mongoBasic.ts #CRUD Methods
 ┃ ┣ 📂interfaces
 ┃ ┣ 📂tools #utils functions
 ┃ ┃ ┗ 📜validateType.ts
 ┃ ┣ 📜app.ts
 ┃ ┣ 📜config.ts
 ┃ ┗ 📜mongo.ts

As an example we will create a crud for the following json.

{
  "name":"Andy",
  "cellphone":303030303,
  "isValid":false
}

We will create a json file and use the following format for the generation of the routes and the controller.

{
  "name":{
    "type":"string",
    "required":true,
    "default":"'Andy'"
  },
  "cellphone":{
    "type":"number",
    "required":false
  },
  "isValid":{
    "type":"boolean",
    "required":true,
    "default":"true"
  }
}

as a key we will assign the name of the property to create.

type: string, number, date, [].
required: false, true.
default(optional): 'true','"Name"'.

We will copy the complete path and execute the generate command.

sabo generate -n=user -p=c:/models/user.json

This will create the interface, controller and routes.

Go to the config.ts file and assign the connection string of our mongo database.

Execute npm start and we will be able to consume the api with our preferred client.

Create

Update

Delete

GetAll

GetById

API REST nodejs, express, mongo con 2 comandos.

thesuperankes — Thu, 30 Sep 2021 13:20:47 +0000

Introducción

SuperApiBoost es un cliente con dos comandos para generar una API REST NodeJS con lenguaje TypeScript usando express para las peticiones y mongoose para base de datos.

Instalación

npm i -g superapiboost

Nuevo proyecto

sabo new -n=[NOMBRE]

Este generará la siguiente estructura:

📦API
 ┣ 📂node_modules
 ┣ 📂src
 ┃ ┣ 📂api
 ┃ ┃ ┣ 📂routes
 ┃ ┃ ┗ 📜index.ts
 ┃ ┣ 📂controllers
 ┃ ┃ ┗ 📜mongoBasic.ts #Basic CRUD Methods
 ┃ ┣ 📂interfaces
 ┃ ┣ 📂tools #transversal functions in the project
 ┃ ┃ ┗ 📜validateType.ts
 ┃ ┣ 📜app.ts
 ┃ ┣ 📜config.ts
 ┃ ┗ 📜mongo.ts
 ┣ 📜package-lock.json
 ┣ 📜package.json
 ┗ 📜tsconfig.json

Antes de arrancar el proyecto se debe agregar el uri de mongo en el archivo config.ts

y despues ejecutar

npm start

Crear las rutas y controladores:

Para crear las rutas y controladores se debe crear un archivo .json con la siguiente estructura:

{
  "name":{
    "type":"string",
    "required":true,
    "default":"'Andy'"
  },
  "cellphone":{
    "type":"number",
    "required":false
  },
  "isValid":{
    "type":"boolean",
    "required":true,
    "default":"true"
  }
}

Y se debe ejecutar el siguiente comando para generar la ruta y controladores:

sabo generate -n=User -p="C:\models\user.json"

Arrancamos el proyecto con

npm start

DEV Community: thesuperankes

REST API CRUD NodeJS, typescript, mongo, express with 2 commands.

Create

Update

Delete

GetAll

GetById

API REST nodejs, express, mongo con 2 comandos.

Introducción

Instalación

Nuevo proyecto

Crear las rutas y controladores:

Create

Update

Delete

GetAll

GetById