Skip to content
This repository was archived by the owner on Nov 14, 2017. It is now read-only.

Home

Jump to bottom
Eric Jiang edited this page Apr 27, 2017 · 6 revisions

All versions previous to v0.7.0 has been depreciated. Visit https://github.com/MonashUnitPlanner/monPlan-API/wiki/v0.7.0-API-Calls for more info on the new API Calls.

As the developers of monPlan, we would like to welcome you and thank you as you take your time visiting this Wiki.

Introduction

This is the API Server built on of Node.js used by monPlanR for server side logic. It is built on a Node.js stack for a modern and robust system. It has various packages such as Express.

The API is not backwards-compatible, any application that uses the API must upgrade request and response handling must upgrade their code upon every MINOR (v0.x.0) release.

How our API works

The API is designed to be robust, broken down into smaller packages allowing it so that if it breaks, only the packages break. Heres how the directory layer looks like (as of v0.3.15-rc2)

Then when you call the api, server.js does the relevant route (if missing it will repond with CANNOT GET blah), then each individual subdirectory under /app/ does the relevant route, it will respond with either a status 404 (missing) a status 500 (Server OK) or a status 200 then it will respond with the result.

We do query's do our database which is powered by Google's Datastore. The public release API is powered by MongoDB

Part of the monPlan Project

Copyright (C) Monash University 2016

Built in conjunction with monScrape | Built with npm, Node.js and Express

Clone this wiki locally