Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rahat-khan-pathan/express.js-mongoose-mvcdesignpattern-practice

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/rahat-khan-pathan/express.js-mongoose-mvcdesignpattern-practice
Owner: Rahat-Khan-Pathan
Created: 2024-01-07T18:09:07.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-01-08T16:30:14.000Z (12 months ago)
Last Synced: 2024-11-07T05:15:21.995Z (about 2 months ago)
Language: JavaScript
Size: 27.3 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# Student Management API

## Introduction

This API provides functionality to manage student records, including adding, retrieving, updating, and deleting student information, using Express.js, Mongoose, MongoDB, and the MVC design pattern.

## How To Run

Run the following command

```bash
npm start
```

## Base URL

All endpoints are relative to the base URL: `http://localhost:5000`

## Endpoints

### Get all Students

- **Endpoint:** `/student/get_all_students`
- **Method:** `GET`
- **Description:** Retrieve a list of all students.

### Add a Student

- **Endpoint:** `/student/add_student`
- **Method:** `POST`
- **Description:** Add a new student to the database.
- **Body:**
```json
{
"fullName": "Rahat Khan",
"class": 11,
"roll": 55,
"section": "C"
}
```

### Get Student by Roll and Class

- **Endpoint:** `/student/get_student_by_roll_class/:roll/:class`
- **Method:** `GET`
- **Description:** Retrieve a student by roll and class.

### Update Student by ID

- **Endpoint:** `/student/update_student_by_id/:id`
- **Method:** `PUT`
- **Description:** Update a student's information by ID.
- **Body:**
```json
{
"fullName": "Rahat Khan",
"class": 11,
"roll": 55,
"section": "C"
}
```

### Get Student by ID

- **Endpoint:** `/student/get_student_by_id/:id`
- **Method:** `GET`
- **Description:** Retrieve a student by ID.

### Delete Student by ID

- **Endpoint:** `/student/delete_student_by_id/:id`
- **Method:** `DELETE`
- **Description:** Delete a student by ID.

### Delete Student by Roll and Class

- **Endpoint:** `/student/delete_student_by_roll_class/:roll/:class`
- **Method:** `DELETE`
- **Description:** Delete a student by roll and class.

### Add Marks

- **Endpoint:** `/student/add_marks`
- **Method:** `POST`
- **Valid Terms:** `First`, `Second`, `Final`
- **Valid Subjects:** `Bangla`, `English`, `Math`
- **Description:** Add marks to the student collection.
- **Body:**
```json
{
"marks": 10,
"roll": 91,
"class": 11,
"term": "First",
"subject": "Bangla"
}
```

### Get All Students Data with Marks

- **Endpoint:** `/student/get_all_students_marks`
- **Method:** `GET`
- **Description:** Get all students data along with their marks in formatted way.

### Get One Student's Data with Marks by ID

- **Endpoint:** `/student/get_student_marks_by_id/:id`
- **Method:** `GET`
- **Description:** Get one student's data along with his/her marks in formatted way.

### Get One Student's Data with Marks by Roll and Class

- **Endpoint:** `/student/get_student_marks_by_roll_class/:roll/:class`
- **Method:** `GET`
- **Description:** Get one student's data along with his/her marks in formatted way.

## Notes

- Ensure to replace `:id`, `:roll`, and `:class` with the actual ID, roll number, and class values respectively when making requests. You can see the postman documentation for more clarifications.