API PROYECTO DELBARRIO.PROVIDENCIA.CL

Versión 1.0.0

Template considerando buenas prácticas en el desarrollo de una API, las tecnología usadas son:

Express 4
Node 8x
Logger
PostgreSQL
Morgan (Logs diarios en archivos planos)
Pg Repositorio
Knex (SQL query builder)
Bookshelf.js (Mapeo objeto-relacional)
jsonwebtoken Repositorio
Passport (Sistema de autenticación basado en estrategias)
Passport-jwt Repositorio (Estrategia de Passport para jsonwebtoken)
bcrypt.js Repositorio
Checkit.js Repositorio (Librería de validación de modelos)
Test mochajs

Caracteristicas consideradas:

Estructura de carpeta independiente por Ruta
Metodos Autodocumentados

INSTALACION

1.- Instalar NodeJS y NPM:

Para sistemas operativos Linux y Windows Ingrese Aqui
Para sistemas operativos OSX Ingrese Aqui.
Si necesita utilizar varias versiones de node puede usar nvm

2.- Instalar dependencias:

$ yarn install o npm install

3.- Instalar Docker-Composer:

[Resumen instalación](https://gist.github.com/mortegac/db6a824fcc94b900672326eabe44464b)

4.- Correr migraciones y seed de base de datos:

$ npm run-script migrate:run
$ npm run-script seed

EJECUCION ENTORNO DE DESARROLLO

Para ejecutar el entorno de Desarrollo fue considerado el uso de contenedores en Docker, actualmente fue solamente considerado una instancia de PostgreSQl para gestionar la base de datos.

1.- Instalación y Pre-Requisitos para instalar Docker-Compose`: * Procedimeinto de instalación

2.- Estructura de carpetas`: Se considero el uso de la siguiente estructura

│   ├── app
│       ├── auth
│       ├── middlewares
│       ├── models
│       ├── specific
│       ├── connection.js
│       ├── private.routes.js
│       ├── public.routes.js
│   ├── log
│   ├── migrations
│   ├── node_modules
│   ├── public
│       ├── img
│   ├── seeds
│   ├── test
├── config.js
├── knexfile.js
├── main.js
├── package.json

Donde:

app\auth : Carpeta que contiene la lógica de autenticación a través de JWT
app\middlewares : carpeta que contiene intermediarios en requests para realizar diversas acciones, como inyección de datos o validación de permisos
app\models : Carpeta que contiene todos los modelos del sistema, separados por carpeta
app\specific : Carpeta que contiene lógicas ajenas a los modelos
app\connection.js : Inicializa el Query Builder y ORM
app\private.routes.js : Posee el ruteo privado de la API
app\public.routes.js : Posee el ruteo público de la API
log : Carpeta que contiene registros diarios de requests a la API
migrations : Carpeta que contiene migraciones a correr con Knex
public\img : Carpeta que contiene las imágenes subidas al servidor
seeds : Carpeta que contiene datos a cargar en la base de datos
config.js : Posee la inicialización/obtención de variables de entorno
knexfile.js : Archivo de configuración del Query Builder
main.js : Inicializa Express con sus dependencias

DEFINICION DE METODOS HTTP UTILIZADOS EN LA API

GET: Consultar y leer recursos
POST: Permite crear un nuevo recurso
PUT: Permite editar un recurso
DELETE: Elimina un recurso

TEST

Se considera test a las rutas expuestas, para esto se utilizan los módulos 'mocha', 'chai' y 'axios'. Los test deben ser generados en la carpeta test como se muestra a continuación

│   └── test
│       ├── persona.js

Los test se ejecutan con el comando npm test / yarn test

INFORMACION GENERAL

Código de Estado de HTTP