Skip to content

This project offers a basic API solution for managing student and address records, featuring endpoints for creating, reading, updating, and deleting entries in a database. Authentication measures are implemented to restrict access to authorized users only, ensuring secure interaction with the system.

Notifications You must be signed in to change notification settings

Bashir-Warsame/Flask-API-Student-Address-Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flask API Student-Address Project

This project is a minimal viable API for managing student and address records. It provides endpoints for creating, reading, updating, and deleting student and address records in a database. The API also includes authentication to ensure that only authorized users can access its endpoints.

Authentication

Authentication is implemented to restrict access to the API's endpoints. Users must register, login, and authenticate themselves to access the API's features securely.

Endpoints

The API serves the following endpoints for both student, address and authentication resources:

Authentication Endpoints

POST /api/register: registers a new user to access the API.

POST /api/login: allows registered users to login.

Student Endpoints

POST /api/student: Creates a new record of a student in the database.

GET /api/student: Retrieves all students from the database.

GET /api/student/<student_id>: Retrieves a student by their ID.

PATCH /api/student/<student_id>: Updates a student's details.

DELETE /api/student/<student_id>: Removes a student from the database.

Address Endpoints

POST /api/address: Creates a new record of an address in the database.

GET /api/address: Retrieves all addresses from the database.

GET /api/address/<address_id>: Retrieves an address by its ID.

PATCH /api/address/<address_id>: Updates an address's details.

DELETE /api/address/<address_id>: Removes an address from the database.

About

This project offers a basic API solution for managing student and address records, featuring endpoints for creating, reading, updating, and deleting entries in a database. Authentication measures are implemented to restrict access to authorized users only, ensuring secure interaction with the system.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published