User Referential CRUD Api

The goal of this project is to provide a simple user referential API.

POST /users/

GET /users/

GET /users/{username}

PUT /users/{username}

DELETE /users/{username}

What I Learned

Develop a Node API with Express framework
Contract validation input/output using directly the openapi documentation (express-openapi-validate)
ORM software (knex js)
& much more

Technical considerations

Environment variables

Name	Description
PORT	Port listen by the server (default set to 8080)
DATABASE_TYPE	The project uses an ORM so we need to define the database's type (default set to postgresql)
DATABASE_NAME	Database's name
DATABASE_USERNAME	Username used to connect to the database
DATABASE_PASSWORD	Password of the latter
DATABASE_HOSTNAME	Database's host (default set to localhost)

Default values are defined in lib/configuration.js

Run docker image of the project

import the image locally

docker pull lsikidi/express-user-referential-crud-api

run the image

docker run \
-p <forwarded_port>:8080 \
-d \
-e "NODE_ENV=production" \
-e "DATABASE_TYPE=<db_type>" \
-e "DATABASE_NAME=<db_name>" \
-e "DATABASE_USERNAME=<db_username>" \
-e "DATABASE_PASSWORD=<db_password>" \
-e "DATABASE_HOSTNAME=<hostname>" \
lsikidi/express-user-referential-crud-api

In order to facilitate the installation of this project on our local machine. The project provide a vagrantfile to automatically provision the virtual machine with all the dependencies needed by the latter.

Prerequisites

install virtualbox (download page)
install vagrant (download page)
install ansible (documentation page)

List of the actions

Go to the source root arborescence of the project
Run this command to provision the VM

ansible-galaxy install -r ./provisioning/requirements.yml
vagrant up

The operation can take some time depending on our internet speed.

Add the hostanem

# add this line to /etc/hosts
192.168.60.8 user-referential-api.local.com

Testing the API

curl -sS http://user-referential-api.local.com:8080/api/v1/users | jq .

Project run in this context:

macOs mojave (10.14.3)
python 3.7.0
ansible 2.7.5
vagrant 2.2.3
virtualbox 6.0.0

loicsikidi / express-user-referential-crud-api