Student-API

Student API Documentation

Base URL:

https://student-api-a5rf.onrender.com

Content-Type:

application/json

---

Student Object Structure

প্রত্যেকটি student object এ নিম্নলিখিত fields থাকবে:

{
  "id": 1026,                 // Number: Student ID (unique, required)
  "name": "Lina Rahman",      // String: Student name (required)
  "age": 20,                  // Number: Student age (required)
  "department": "CSE",        // String: Department name (required)
  "results": {                // Object: Academic results (required)
    "jsc": 86,                // Number: JSC marks
    "ssc": 88,                // Number: SSC marks
    "hsc": 90                 // Number: HSC marks
  },
  "skills": ["MongoDB", "Express.js"] // Array of Strings: Student skills (optional)
}

---

1️⃣ Get All Students

Endpoint:

GET /students

Description:
সকল students এর list retrieve করে।

Response Example:

{
  "status": "success",
  "code": 200,
  "data": [
    {
      "id": 1026,
      "name": "Lina Rahman",
      "age": 20,
      "department": "CSE",
      "results": { "jsc": 86, "ssc": 88, "hsc": 90 },
      "skills": ["MongoDB", "Express.js"]
    },
    {
      "id": 1027,
      "name": "Imran Hossain",
      "age": 21,
      "department": "BBA",
      "results": { "jsc": 78, "ssc": 80, "hsc": 82 },
      "skills": ["Marketing", "Management"]
    }
  ]
}

---

2️⃣ Get Single Student by ID

Endpoint:

GET /students/id/:id

Description:
নির্দিষ্ট student এর ID দিয়ে তথ্য retrieve করে।

URL Params:  id : Student ID (required)

Response Example:

{
  "status": "success",
  "code": 200,
  "data": {
    "id": 1026,
    "name": "Lina Rahman",
    "age": 20,
    "department": "CSE",
    "results": { "jsc": 86, "ssc": 88, "hsc": 90 },
    "skills": ["MongoDB", "Express.js"]
  }
}

---

3️⃣ Create New Student

Endpoint:

POST /students

Description:
নতুন student create করে।

Request Body Example:

{
  "id": 1051,
  "name": "Ali Hasan",
  "age": 20,
  "department": "CSE",
  "results": { "jsc": 85, "ssc": 88, "hsc": 90 },
  "skills": ["JavaScript", "Node.js"]
}

Response Example:

{
  "status": "success",
  "code": 201,
  "message": "New student added",
  "data": {
    "id": 1051,
    "name": "Ali Hasan",
    "age": 20,
    "department": "CSE",
    "results": { "jsc": 85, "ssc": 88, "hsc": 90 },
    "skills": ["JavaScript", "Node.js"]
  }
}

---

4️⃣ Update Student by ID

Endpoint:

PUT /students/id/:id

Description:
নির্দিষ্ট student update করে।

URL Params:  id : Student ID (required)

Request Body Example:

{
  "name": "Lina Rahman",
  "age": 21,
  "department": "CSE",
  "results": { "jsc": 87, "ssc": 89, "hsc": 91 },
  "skills": ["MongoDB", "Express.js", "React"]
}

Response Example:

{
  "status": "success",
  "code": 200,
  "message": "Student updated",
  "data": {
    "id": 1026,
    "name": "Lina Rahman",
    "age": 21,
    "department": "CSE",
    "results": { "jsc": 87, "ssc": 89, "hsc": 91 },
    "skills": ["MongoDB", "Express.js", "React"]
  }
}

---

5️⃣ Delete Student by ID

Endpoint:

DELETE /students/id/:id

Description:
নির্দিষ্ট student delete করে।

URL Params:   id : Student ID (required)

Response Example:

{
  "status": "success",
  "code": 200,
  "message": "Student deleted successfully"
}

---

💡 Notes:

1. সব request এর জন্য Content-Type: application/json ব্যবহার করুন।

2. results object-এ সব তিনটি field (jsc, ssc, hsc) অবশ্যই দিতে হবে।

3. skills optional, যদি না দেন তবে default হবে empty array []।

---