aa-avila / alkemy-warmup-blog

Alkemy Warm Up Challenge: Blog API

Alkemy Warm Up Challenge: Blog API

Installation

Instalar mediante NPM:

npm install

Para ejecutar una versión local, se requiere disponer en funcionamiento una base de datos mysql, ya sea de forma local o remota.

Además se deberá crear un archivo .env, el cual contenrá las siguientes variables de entorno:

# CUSTOM PORT
CUSTOM_PORT=****

# DATABASE PARAMS
DB_USERNAME=****
DB_PASSWORD=****
DB_DATABASE=****
DB_HOST=****
DB_PORT=3306
DB_DIALECT=mysql 

La librería dotenv configura automáticamente dichas variables a partir de este archivo.

Iniciar el servidor con el comando:

npm start

De manera opcional, se puede iniciar el servidor con nodemon con el siguiente comando:

npm run dev

Endpoints

Posts

• getAll GET: /posts params (optional): order = ASC || DESC
• getOne GET: /posts/:id
• create POST: /posts
• update PATCH: /posts/:id
• deleteOne DELETE: /posts/:id

Categories

• getAll GET: /categories
• getOne GET: /categories/:id
• create POST: /categories
• update PATCH: /categories/:id
• deleteOne DELETE: /categories/:id