This API provides endpoints for managing student records in a library system. It allows CRUD operations for students' data.
The detailed API documentation can be found here. The APi is deployed in render. Check out the API with this link.
- Python
- FastAPI
- MongoDB
- Clone the repository.
- Install the required dependencies using
pip install -r requirements.txt
. - Set up your MongoDB URI in the
.env
file. - Run the API using
uvicorn main:app --reload
.
- GET /students: Retrieve a list of all students.
- GET /students/{id}: Retrieve details of a specific student.
- POST /students: Create a new student record.
- PATCH /students/{id}: Update an existing student record.
- DELETE /students/{id}: Delete a student record.
- Ensure the API is running locally or deployed.
- Use tools like Postman or cURL to send requests to the API endpoints.
- Follow the API documentation for request formats and responses.
Contributions are welcome! Please follow the contribution guidelines outlined in CONTRIBUTING.md.
This project is licensed under the MIT License. See the LICENSE file for details.