https://github.com/1adityakadam/build-a-rest-api-in-python

This project showcases creating a RESTful API using Flask and SQLAlchemy. It demonstrates CRUD operations, database integration with SQLite, and endpoint testing via Postman, providing a hands-on introduction to API development and backend fundamentals.
https://github.com/1adityakadam/build-a-rest-api-in-python

crud-operation flask rest-api sqlalchemy

Last synced: 2 days ago
JSON representation

This project showcases creating a RESTful API using Flask and SQLAlchemy. It demonstrates CRUD operations, database integration with SQLite, and endpoint testing via Postman, providing a hands-on introduction to API development and backend fundamentals.

• Host: GitHub
• URL: https://github.com/1adityakadam/build-a-rest-api-in-python
• Owner: 1adityakadam
• Created: 2025-09-26T23:08:55.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-09-26T23:20:33.000Z (10 months ago)
• Last Synced: 2025-10-29T22:40:52.587Z (9 months ago)
• Topics: crud-operation, flask, rest-api, sqlalchemy
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Build a REST API in Python

This project demonstrates how to build a fully functional REST API in Python using Flask and SQLAlchemy. It covers everything from the basics of APIs to integrating a database and testing endpoints with Postman.

 


## What is an API?

An API (Application Programming Interface) allows communication between a client (front-end) and a server (back-end).

This project implements a REST API (Representational State Transfer), which organizes resources into unique URIs and supports standard `CRUD operations`:

- POST → Create data

- GET → Read data

- PUT → Update data

- DELETE → Delete data

All interactions are handled with JSON payloads for cross-language compatibility.

## Tech Stack

- Python 3

- Flask → Lightweight framework for API routes

- Flask-SQLAlchemy → ORM to manage database models

- SQLite → Database backend

- Postman → API testing

## Setup Instructions

 ## Clone the repo

- git clone https://github.com/your-username/build-rest-api-python.git

- cd build-rest-api-python

## Create a virtual environment

- python3 -m venv api_env

- source api_env/bin/activate

## Install dependencies

pip install -r requirements.txt

## Run the app

python app.py

Your API will be live at:

http://127.0.0.1:5000



## Database Model

The project uses a simple Destinations table:

- Field	Type	Description

- id	Integer	Primary key

- destination	String	City or location name

- country	String	Associated country

- rating	Float	Rating score (1.0 - 5.0)

## API Endpoints

Method	Endpoint	Description

- GET	/	Welcome message

- GET	/destinations	Fetch all destinations

- GET	/destinations/	Fetch destination by ID

- POST	/destinations	Add a new destination

- PUT	/destinations/	Update destination by ID

- DELETE	/destinations/	Delete destination by ID

## Testing with Postman

Open Postman and enter the API base URL:

http://127.0.0.1:5000

##Test requests:

- GET /destinations → Returns all data in JSON.

- POST /destinations with body:

    `{

      "destination": "Paris",

      "country": "France",

      "rating": 4.8

    }`

- PUT /destinations/1 → Update entry with ID 1.

- DELETE /destinations/1 → Remove entry with ID 1.

---

`### Learnt from ~ Code with Josh @ YT`

---