Skip to content

ankush-kash/notes-api-fastapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes API

A RESTful Notes API built with FastAPI, PostgreSQL, SQLAlchemy, and Alembic.

Features

  • Create notes
  • Read notes
  • Update notes
  • Delete notes
  • PostgreSQL integration
  • Alembic migrations
  • Pydantic validation

Tech Stack

  • FastAPI
  • SQLAlchemy
  • PostgreSQL
  • Alembic
  • Pydantic

Installation

git clone https://github.com/ankush-kash/notes-api-fastapi.git


python -m venv venv

venv\Scripts\activate


Install dependencies:

pip install -r requirements.txt


Run migrations:

alembic upgrade head


Start server:

uvicorn app.main:app --reload


API Endpoints :-

Method	Endpoint	    Description
GET	    /notes	        Get all notes
POST	/notes	        Create note
PUT	    /notes/{id}	    Update note
DELETE	/notes/{id}	    Delete note    

About

FastAPI-based backend application for managing notes with full CRUD functionality. Built using PostgreSQL for data persistence, SQLAlchemy ORM for database interactions, Pydantic for data validation, and Alembic for database migrations. Designed with scalable backend architecture and REST API principles.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors