UST School Administration Systems API Test

Node Version

v15.4.0

Unit Tests

Tests are run using jest and supertest

npm test

Test suites

validation tests
1. Should accept full entries
2. Should not accept missing entries
3. Should not accept empty fields
endpoint tests
1. GET /workload should return 200
2. POST /register should return 204 with full body information
3. POST /register should 400 if body is missing items
4. POST /register should return 400 if body has empty fields

Initialising the API server

Install dependencies

npm install

Start server

npm start

This will start a docker container, and migrate the database from /database/DDL.sql

API Docuemntation

All reqeusts should be made to this base URL:

http://localhost:3000/api

Test

/healthcheck

method: `GET`

expected response: `200 OK`

Registering A New Lesson With Teachers, Students, Classes, and Subject

/register

method: `POST`

required payload:

teacher
- name
- email
students (array of)
- name
- email
subject
- name
- subjectCode
class
- name
- classCode

If any of the items already exist as their unique identifier, but name fields are different, it will be updated to that provided in the request.

All fields must be provided.

Example body:

{
  "students": [
    {
      "name": "Student A",
      "email": "[email protected]"
    },
    {
      "name": "Student B",
      "email": "[email protected]"
    }],
   "class": {
      "classCode": "P1-1",
      "name": "P1 AA"
   },
   "subject": {
      "subjectCode": SCI,
      "name": "Science"
   },
      "teacher": {
      "name": Teacher 1,
      "email": "[email protected]"
   }
}

expected response: `204 NO CONTENT`

Retrieving Overall Workload

/reports/workload

method: GET
expected response: 200

    {
      "Teacher 1": [
        {
          "subjectCode": "ENG",
          "subjectName": "English",
          "numberOfClasses": 1,
        },        
        {
          "subjectCode": "MATH",
          "subjectName": "Mathematics",
          "numberOfClasses": 3,
        },
      ],
      "Teacher 2": [
        {
          "subjectCode": "ENG",
          "subjectName": "English",
          "numberOfClasses": 2,
        },
      ],
    }

ryhuz / ust-sas-api-test Goto Github PK

ust-sas-api-test's Introduction

UST School Administration Systems API Test

Unit Tests

Test suites

Initialising the API server

API Docuemntation

Test

method: GET

expected response: 200 OK

Registering A New Lesson With Teachers, Students, Classes, and Subject

method: POST

required payload:

Example body:

expected response: 204 NO CONTENT

Retrieving Overall Workload

ust-sas-api-test's People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org

method: `GET`

expected response: `200 OK`

method: `POST`

expected response: `204 NO CONTENT`