Documentation Powered by ReDoc

Student Portal (1.0.0)

Download OpenAPI specification:Download

GetStudents

Get A list of All The Students

Responses

200

A JSON Array of Students

get/getAll
http://localhost:8081/getAll

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Student By Name

Get Student Details by name

path Parameters
name
required
string

Responses

200

Details Fetched Status Ok

400

No Entry Found By that Name

get/getStud/{name}
http://localhost:8081/getStud/{name}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Add a Student to Catalog

Add a Student

Request Body schema: application/json

Student Object That Needs to be added

studentName
string
studentAge
string
studentMarks
string

Responses

200

The student has been added Successfully

post/stud
http://localhost:8081/stud

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "studentName": "string",
  • "studentAge": "string",
  • "studentMarks": "string"
}

Update Student Details in the Catalog

Update Student Details

path Parameters
name
required
string

Student Name to Update Details

Request Body schema: application/json

Updated Student Details

studentName
string
studentAge
string
studentMarks
string

Responses

200

Student Updated Successfully

400

Invalid Student Name Specified

404

Student Not Found

put/upStud/{name}
http://localhost:8081/upStud/{name}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "studentName": "string",
  • "studentAge": "string",
  • "studentMarks": "string"
}

Delete a Student from Catalog

Delete a Students Info

path Parameters
name
required
string

Name of the Student to be Deleted

Responses

200

Removed Successfully

400

invalid username supplied

404

Student not Found

delete/remStud/{name}
http://localhost:8081/remStud/{name}