Org Chart Api

Restful API built using Drogon.
Routes are protected using JWT for token-based authorization.

Endpoints

Persons

Method	URI	Action
GET	/persons?limit={}&offset={}&sort_field={}&sort_order={}	Retrieve all persons
GET	/persons/{id}	Retrieve person
GET	/persons/{id}/reports	Retrieve person direct reports
POST	/persons	Create person
PUT	/persons/{id}	Update person
DELETE	/persons/{id}	Delete person

Departments

Method	URI	Action
GET	/departments?limit={}&offset={}&sort_field={}&sort_order={}	Retrieve all departments
GET	/departments/{id}	Retrieve department
GET	/departments/{id}/persons	Retrieve department persons
POST	/departments	Create department
PUT	/departments/{id}	Update department
DELETE	/departments/{id}	Delete department

Jobs

Method	URI	Action
GET	/jobs?limit={}&offset={}&sort_fields={}&sort_order={}	Retrieve all jobs
GET	/jobs/{id}	Retrieve job
GET	/jobs/{id}/persons	Retrieve job persons
POST	/jobs	Create job
PUT	/jobs/{id}	Update job
DELETE	/jobs/{id}	Delete job

Auth

Method	URI	Action
POST	/auth/register	Register user and obtain JWT token
POST	/auth/login	Login User

How to build the project

Installation

See drogon documentation here!

Verify Installation

Confirm the database development environment using drogon_ctl -v:

     _                                                                                                                                                                                                       [0/365]
  __| |_ __ ___   __ _  ___  _ __
 / _` | '__/ _ \ / _` |/ _ \| '_ \
| (_| | | | (_) | (_| | (_) | | | |
 \__,_|_|  \___/ \__, |\___/|_| |_|
                 |___/

A utility for drogon
Version: 1.7.5
Git commit: fc68b8c92c8c202d8cc58d83629d6e8c8701fc47
Compilation:
  Compiler: /Library/Developer/CommandLineTools/usr/bin/c++
  Compiler ID: AppleClang
  Compilation flags: -std=c++17 -I/usr/local/include
Libraries:
  postgresql: yes  (batch mode: no)
  mariadb: yes
  sqlite3: yes
  openssl: yes
  brotli: yes
  boost: no
  hiredis: no
  c-ares: yes

Setup Database

Start a postgres server.
docker run --name pg -e POSTGRES_PASSWORD=password -d -p 5433:5432 postgres

Log into postgres using psql to create a org_chart database.
psql 'postgresql://postgres:[email protected]:5433/org_chart'

Create and seed the tables.
psql 'postgresql://postgres:[email protected]:5433/org_chart' -f scripts/create_db.sql
psql 'postgresql://postgres:[email protected]:5433/org_chart' -f scripts/seed_db.sql

Build

git clone https://github.com/maikeulb/orgChartApi
git submodule update --init
mkdir build
cd build
cmake ..
make

Run

Make the necessary database changes to config.json and run the project ./org_chart

Usage

1. register user
   http post localhost:3000/auth/register username="admin" password="password"

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE2NDU4MzE2MDcsImlhdCI6MTY0NTgzMTYwNywiaXNzIjoiYXV0aDAiLCJ1c2VyX2lkIjoiMCJ9.8PyNKVTlY6Qy81kXrCXTSD2XRxSKHLxmIELqEmOyFoU",
    "username": "admin"
}

2. login user and obtain token (can also obtain token after registering)
   http post localhost:3000/auth/login username="admin" password="password"

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE2NDU4MzE2MDcsImlhdCI6MTY0NTgzMTYwNywiaXNzIjoiYXV0aDAiLCJ1c2VyX2lkIjoiMCJ9.8PyNKVTlY6Qy81kXrCXTSD2XRxSKHLxmIELqEmOyFoU",
    "username": "admin"
}

3. access resource using token
   http --auth-type=bearer --auth="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE2NDU4MzE2MzYsImlhdCI6MTY0NTgzMTYzNiwiaXNzIjoiYXV0aDAiLCJ1c2VyX2lkIjoiMyJ9.x84yaRyC8sxjfRqeBC9AJW4NUAA2nhDexFUh3lImF50" get localhost:3000/persons offset=1 limit=25 sort_field=id sort_order=asc

[
   {
        "department": {
            "id": 1,
            "name": "Product"
        },
        "first_name": "Gary",
        "hire_date": "2018-04-07 01:00:00",
        "id": 2,
        "job": {
            "id": 2,
            "title": "M1"
        },
        "last_name": "Reed",
        "manager": {
            "id": 1,
            "full_name": "Sabryna Peers",
        }
    },
    {
        "department": {
            "id": 1,
            "name": "Product"
        },
        "first_name": "Madonna",
        "hire_date": "2018-03-08",
        "id": 3,
        "job": {
            "id": 2,
            "title": "M1"
        },
        "last_name": "Axl",
        "manager": {
            "id": 1,
            "full_name": "Sabryna Peers",
        }
    },
    {
        "department": {
            "id": 1,
            "name": "Product"
        },
        "first_name": "Marcia",
        "hire_date": "2020-01-11",
        "id": 4,
        "job": {
            "id": 4,
            "title": "E5"
        },
        "last_name": "Stuart",
        "manager": {
            "id": 2,
            "full_name": "Gary Reed",
        }
    },
...
]

Troubleshooting

• Ensure that openssl is installed correctly (check drogon_ctl -v) and point cmake to the correct directory.
  cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
• If you're using a LSP, export compile_commands.json
cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DCMAKE_EXPORT_COMPILE_COMMANDS=