Added request body parsing

README.md

@@ -1 +1,13 @@
 # Moodle Course API
+
+The Moodle-Course-API provides a read-only interface to easily 
+query whether a user has completed a course, or a quiz. This can
+be used in other applications (such as the Training-Center) to 
+determine a member's progress within a specific course. 
+
+## API Interface
+
+| Method |        Path         | Parameters                             | Response                                                     | Description                                                                                                                              |
+|:------:|:-------------------:|:---------------------------------------|:-------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
+| `GET`  | `/course_completed` | `{course_id: number, user_id: number}` | `{course_name: string, completed: bool, completed_at: Date}` | Returns the provided response for the provided parameters. Returns a `400` HTTP Error in the event of missing parameters.                |
+| `GET`  |  `/quiz_completed`  | `{module_id: number, user_id: number}` | Result of the `SELECT` statement                             | Returns the result of the `SELECT` statement for the provided parameters. Returns a `400` HTTP Error in the event of missing parameters. |

index.ts

@@ -3,6 +3,7 @@ import { initializeApplication } from "./src/core/StartupRoutine";
 import { Config } from "./src/core/Config";
 import Logger, { LogLevels } from "./src/utility/Logger";
 import { apiRouter } from "./src/routes/ApiRouter";
+import bodyParser from "body-parser";
 
 const application = express();
 
@@ -11,6 +12,7 @@ initializeApplication()
         application.listen(Config.APP_PORT, () => {
             Logger.log(LogLevels.LOG_SUCCESS, `Server is running on http://localhost:${Config.APP_PORT}`, true);
         });
+        application.use(bodyParser.json());
 
         application.use(apiRouter);
     })

package.json

@@ -17,8 +17,10 @@
     "author": "VATSIM Germany <[email protected]>",
     "license": "GPL3",
     "dependencies": {
+        "@types/body-parser": "^1.19.2",
         "@types/express": "^4.17.14",
         "@types/sequelize": "^4.28.14",
+        "body-parser": "^1.20.2",
         "dotenv": "^16.0.3",
         "express": "^4.18.2",
         "mysql2": "^2.3.3",

src/routes/ApiRouter.ts

@@ -12,7 +12,7 @@ apiRouter.get("/course_completed", async (req, res) => {
     const user_id = req.query.user_id;
 
     if (course_id == null || user_id == null) {
-        res.status(404).send({ error: "Missing required parameters" });
+        res.status(400).send({ error: "Missing required parameters" });
         return;
     }
 
@@ -45,7 +45,7 @@ apiRouter.get("/quiz_completed", async (req, res) => {
     const user_id = req.query.user_id;
 
     if (module_id == null || user_id == null) {
-        res.status(404).send({ error: "Missing required parameters" });
+        res.status(400).send({ error: "Missing required parameters" });
         return;
     }