Skip to content

Latest commit

 

History

History
252 lines (173 loc) · 5.33 KB

Documentation.md

File metadata and controls

252 lines (173 loc) · 5.33 KB

Project Documentation

Project Overview

  • Project Name: Campus API
  • Description: A RESTful API for managing college information.

API Implementation

  • Description: This section outlines the API endpoints and functionality that need to be implemented for the Campus API.

Endpoints to Implement

Middlewares (Utils)

  1. JWT Middleware
    • Description: Middleware for verifying JWT tokens.
    • Deadline: [Deadline]
    • Assigned To: Majid

Authentication Endpoints

  1. POST /auth/register

    • Description: Register a new user.
    • Deadline: 22-03-23
    • Assigned To: Majid

  2. POST /auth/login

    • Description: Login a user.
    • Deadline: 22-03-23
    • Assigned To: Majid

  3. POST /auth/verify

    • Description: Verify a user's email.
    • Deadline: 22-03-23
    • Assigned To: Majid

User Endpoints

  1. GET /user

    • Description: Retrieve all users.
    • Deadline: 25-03-24
    • Assigned To: Anurag

  2. GET /user/:id

    • Description: Retrieve a specific user by ID.
    • Deadline: 25-03-24
    • Assigned To: Anurag

  3. POST /user

    • Description: Create a new user.
    • Deadline: 25-03-24
    • Assigned To: Anurag

College Endpoints

  1. GET /college
    • Description: Retrieve all colleges.
    • Deadline: 22-03-23
    • Assigned To: Sreni
  2. GET /college/:id
    • Description: Retrieve a specific college by ID.
    • Deadline: 22-03-23
    • Assigned To: Sreni
  3. POST /college
    • Description: Create a new college.
    • Deadline: 22-03-23
    • Assigned To: Sreni
  4. PUT /college/:id
    • Description: Update a specific college by ID.
    • Deadline: 22-03-23
    • Assigned To: Sreni
  5. DELETE /college/:id
    • Description: Delete a specific college data by ID.
    • Deadline: 22-03-23
    • Assigned To: Sreni

Faculty Endpoints

  1. GET /faculty

    • Description: Retrieve all faculties.
    • Deadline: 22-03-23
    • Assigned To: Sreelakshami

  2. GET /faculty/:id

    • Description: Retrieve a specific faculty by ID.
    • Deadline: 22-03-23
    • Assigned To: [Developer Name]

  3. POST /faculty

    • Description: Create a new faculty.
    • Deadline: 22-03-23
    • Assigned To: [Developer Name]

  4. PUT /faculty/:id

    • Description: Update a specific faculty by ID.
    • Deadline: 22-03-23
    • Assigned To: [Developer Name]

Department Endpoints

  1. GET /department

    • Description: Retrieve all departments.
    • Deadline: 22-03-23
    • Assigned To: Niranjana

  2. GET /department/:id

    • Description: Retrieve a specific department by ID.
    • Deadline: 22-03-23`
    • Assigned To: Niranjana

  3. POST /department

    • Description: Create a new department.
    • Deadline: 22-03-23
    • Assigned To: Niranjana

  4. PUT /department/:id

    • Description: Update a specific department by ID.
    • Deadline: 22-03-23
    • Assigned To: Niranjana

  5. DELETE /department/:id

    • Description: Delete a specific department by ID.
    • Deadline: 22-03-23
    • Assigned To: Niranjana

Scheme Endpoints

  1. GET /scheme

    • Description: Retrieve all schemes.
    • Deadline: 22-03-23
    • Assigned To: Ritha

  2. GET /scheme/:id

    • Description: Retrieve a specific scheme by ID.
    • Deadline: 22-03-23
    • Assigned To: Ritha

  3. POST /scheme

    • Description: Create a new scheme.
    • Deadline: 22-03-23
    • Assigned To: Ritha

  4. PUT /scheme/:id

    • Description: Update a specific scheme by ID.
    • Deadline: 22-03-23
    • Assigned To: Ritha

  5. DELETE /scheme/:id

    • Description: Delete a specific scheme by ID.
    • Deadline: 22-03-23
    • Assigned To: Ritha

Student Endpoints

  1. GET /student

    • Description: Retrieve all students.
    • Deadline: 25-03-24
    • Assigned To: Sreni

  2. GET /student/:id

    • Description: Retrieve student details by id
    • Deadline: 25-03-24
    • Assigned To: Sreni

  3. POST /student

    • Description: Create a student
    • Deadline: 25-03-24
    • Assigned To: Sreni

  4. PUT /student/:id

    • Description: Update student details
    • Deadline: 25-03-24
    • Assigned To: Sreni

Course Endpoints

  1. GET /course

    • Description: Retrieve all courses.
    • Deadline: 25-03-24
    • Assigned To: Niranjana

  2. GET /course/:id

    • Description: Retrieve a specific course by ID.
    • Deadline: 25-03-24
    • Assigned To: Niranjana

  3. POST /course

    • Description: Create a new course.
    • Deadline: 25-03-24
    • Assigned To: Niranjana

  4. PUT /course/:id

    • Description: Update a specific course by ID.
    • Deadline: 25-03-24
    • Assigned To: Niranjana

Program Endpoints

  1. GET /program

    • Description: Retrieve all programs.
    • Deadline: 25-03-24
    • Assigned To: Ritha

  2. POST /program

    • Description: Create a program
    • Deadline: 25-03-24
    • Assigned To: Ritha

  3. PUT /program/:id

    • Description: Update a program
    • Deadline: 25-03-24
    • Assigned To: Ritha

  4. DELETE /program/:id

    • Description: Delete a program
    • Deadline: 25-03-24
    • Assigned To: Ritha

Testing and Debugging

  • Description: This section outlines the testing and debugging phase of the project.

Testing Plan

  • Unit Testing: Test each API using Postman or Hoppscotch using dummy data.