https://github.com/prateekmaj21/students_db_sql
An complete application that performs CRUD (Create, Read, Update, Delete) operations on a MySQL database using Python.
https://github.com/prateekmaj21/students_db_sql
postman python sql sqldatabase
Last synced: 2 months ago
JSON representation
An complete application that performs CRUD (Create, Read, Update, Delete) operations on a MySQL database using Python.
- Host: GitHub
- URL: https://github.com/prateekmaj21/students_db_sql
- Owner: prateekmaj21
- License: mit
- Created: 2024-07-13T12:06:26.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T07:06:22.000Z (9 months ago)
- Last Synced: 2024-07-23T09:03:18.107Z (9 months ago)
- Topics: postman, python, sql, sqldatabase
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Students Database using FastAPI and MYSQL
The objective of this project is to develop a complete application that performs CRUD (Create, Read, Update, Delete) operations on a MySQL database using Python.
Video Implementation: [Youtube](https://youtu.be/xDrCJacrwo4?si=ChAg_KPDszRpmYB8)
# Prerequisites
## MySQL Database Setup
1. Ensure you have MySQL Server installed and running.
2. Create a database named `school` and a table named `students` with appropriate columns (`id`, `name`, `age`, `grade`). Refer to the instructions for setting up the database.
## Python Environment
1. Make sure you have Python installed on your system. You can download Python from [python.org](https://www.python.org) if not already installed.
# Project Files
1. **database.py**: Implement MySQL connection and CRUD operations.
2. **main.py**: Implement FastAPI application with CRUD endpoints.
3. **requirements.txt**: List the Python dependencies (fastapi, uvicorn, mysql-connector-python).
---
## requirements.txt
```text
fastapi==0.70.0
uvicorn==0.15.0
mysql-connector-python==8.0.28
```
# How to Use:
Create a new file named requirements.txt in your project directory.
Copy the above dependencies into `requirements.txt`.
Install these dependencies using pip:
```text
pip install -r requirements.txt
```
By including these dependencies in your requirements.txt file, you ensure that anyone setting up your FastAPI project can easily install the necessary packages with a single command.
# Install uvicorn Globally
UVICORN is an ASGI (Asynchronous Server Gateway Interface) web server implementation tailored for Python.
```text
pip install uvicorn
```
To run it:
```text
uvicorn main:app --reload
python -m uvicorn main:app --reload
```
Once uvicorn starts your FastAPI application successfully, you should see output indicating that the server is running, usually on `http://127.0.0.1:8000` by default.
### Terminate the Server:
To stop the FastAPI application, press `Ctrl + C` in the terminal or command prompt where the server is running.
### MySQL Server
```text
import mysql.connector
from mysql.connector import Error
def create_connection():
connection = None
try:
connection = mysql.connector.connect(
host="localhost",
user="root",
password="1234",
database="school"
)
print("Connection to MySQL DB successful")
except Error as e:
print(f"The error '{e}' occurred")
return connection
```
**host:** The hostname or IP address where your MySQL server is running. Typically, if it's on your local machine, you use "localhost".
**user:** The username to authenticate with the MySQL server.
**password:** The password corresponding to the username for authentication.
**database:** The name of the database you want to connect to.
### Create Database and Table:
```text
CREATE DATABASE school;
USE school;
CREATE TABLE students (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(100) NOT NULL,
age INT NOT NULL,
grade VARCHAR(10) NOT NULL
);
```
### Explanation:
1. **CREATE DATABASE**: This SQL command creates a new database named school.
2. **USE school**: Sets the school database as the current working database.
3. **CREATE TABLE students**: Defines a table named students within the school database. It includes columns `id`(auto-incremented integer and primary key), `name` (string), `age` (integer), and `grade` (string).
## CRUD:
To perform CRUD operations on your FastAPI application using Postman, you'll use HTTP methods (`POST`, `GET`, `PUT`, `DELETE`) to interact with your API endpoints.
Here’s how you can set up and execute these commands in Postman:
### Prerequisites:
Ensure your FastAPI application is running using uvicorn as explained earlier.
### 1. Create a Student (POST Request)
Method: **POST**
URL: http://127.0.0.1:8000/students/
#### Headers:
- **Content-Type**: application/json
- **Accept**: application/json
```text
{
"name": "John Doe",
"age": 21,
"grade": "A"
}
```
Click `Send`. You should receive a response confirming the creation of the student.
### 2. Get All Students (GET Request)
Method: **GET**
URL: http://127.0.0.1:8000/students/
#### Headers:
- **Accept**: application/json
Click `Send`. You should receive a response with a list of all students.
### 3. Get a Student by ID (GET Request)
Method: **GET**
URL: http://127.0.0.1:8000/students/{student_id}
Replace `{student_id}` with the ID of the student you want to fetch.
#### Headers:
- **Accept**: application/json
Click `Send`. You should receive a response with the student details if the student exists.
### 4. Update a Student (PUT Request)
Method: **PUT**
URL: http://127.0.0.1:8000/students/{student_id}
Replace `{student_id}` with the ID of the student you want to update.
#### Headers:
- **Content-Type**: application/json
- **Accept**: application/json
```text
{
"name": "Jane Doe",
"age": 22,
"grade": "A+"
}
```
### 5. Delete a Student (DELETE Request)
Method: **DELETE**
URL: http://127.0.0.1:8000/students/{student_id}
Replace `{student_id}` with the ID of the student you want to delete.
#### Headers:
- **Accept**: application/json
Click `Send`. You should receive a response confirming the deletion of the student.
### Notes:
- Ensure the FastAPI server `(uvicorn main:app --reload)` is running while testing with Postman.
- Adjust the URL `(127.0.0.1:8000)` and endpoint paths `(/students/, /students/{student_id})` based on the FastAPI application's configuration.
- Verify each operation's success through Postman's response and status codes `(200 OK, 201 Created, 204 No Content, 404 Not Found, etc.)`.
By following these steps, we can effectively test the FastAPI application's CRUD operations using Postman, ensuring that the API endpoints behave as expected when interacting with the MySQL database.