CampusX - REST API

---

Getting started

To get the Node server running locally:

• Clone this repo
• npm install to install all required dependencies
• Install MySQL and edit the database config at src/config/db.config.js
• Configure the JWT secret key at src/config/api.config.js
• npm start to start the local server

node src/index.js c or npm startc to delete all tables before running. node src/server.js or npm start to continue with existing tables before running.

---

Code Overview

Dependencies

• expressjs - The server for handling and routing HTTP requests
• sequelize - Modelling and handling SQL commands
• mysql2 - MySQL client for NodeJS

Application Structure

• server.js - The entry point to the application. Defines our express server and connects it to MySQL using Sequelize. It also requires the routes and models that will be used.
• config/ - Configuration for the database.
• routes/ - Route definitions for our API.
• models/ - Schema definitions for our Sequelize models.
• controllers/ - Contoller functions as specified in the routes.
• middleware/ - Handles JWT authentication and image uploads.

---

API Spec (Documentation is WIP)

JSON Objects returned by API:

api/users/1 - returns user json of specified id

{
    "createdAt": "2020-04-23T10:14:51.625Z",
    "email": "a@b.com",
    "gtoken": "1433981953",
    "id": 1,
    "name": "Chuck Norris",
    "phone": "1234567890",
    "updatedAt": "2020-04-23T10:14:51.625Z"
}

api/users - returns array of all users

[
    {
        "createdAt": "2020-04-23T10:14:51.000Z",
        "email": "a@b.com",
        "gtoken": "1433981953",
        "id": 1,
        "name": "Chuck Norris",
        "phone": 1234567890,
        "updatedAt": "2020-04-23T10:14:51.000Z"
    },
    {
        "createdAt": "2020-04-23T10:16:20.000Z",
        "email": "c@m.com",
        "gtoken": "1654732678",
        "id": 2,
        "name": "Wilbur A",
        "phone": 1234588888,
        "updatedAt": "2020-04-23T10:16:20.000Z"
    }
]

api/things/1 - returns user json of specified id

{
    "createdAt": "2020-04-23T10:14:51.625Z",
    "donation": true,
    "email": "a@b.com",
    "gtoken": "1433981953",
    "id": 1,
    "name": "Chuck Norris",
    "phone": "1234567890",
    "updatedAt": "2020-04-23T10:14:51.625Z"
}

api/things - returns array of all things

[
    {
        "book": null,
        "branch": "ise",
        "createdAt": "2020-04-23T10:23:28.000Z",
        "donation": true,
        "drive": {
            "description": "nice link and stuff",
            "id": 1,
            "thingId": 2,
            "url": "www.drive.com"
        },
        "id": 2,
        "other": null,
        "sem": "V",
        "title": "5 sem notes and papers",
        "updatedAt": "2020-04-23T10:23:28.000Z",
        "userId": 1
    },
    {
        "book": {
            "author": "Arthur B",
            "id": 1,
            "image": "www.imgur.com/aseds.png",
            "publisher": "Small Penguin Publishers",
            "thingId": 1
        },
        "branch": "cse",
        "createdAt": "2020-04-23T10:22:57.000Z",
        "donation": true,
        "drive": null,
        "id": 1,
        "other": null,
        "sem": "III",
        "title": "C Programming",
        "updatedAt": "2020-04-23T10:22:57.000Z",
        "userId": 1
    }
]

Returns most recent things by default, provide title, sem, branch or donation query parameter to filter results

Filter by title: ?title=CProgramming

Filter by sem: ?sem=4

Filter by branch: ?branch=CSE

Filter donations: ?donation=1

Combine multiple filters: ?sem=4&branch=CSE