Skip to content

A FastAPI-based task manager API that allows users to create, view, update, and delete tasks. It features API key authentication for secure access and uses SQLite for storage. Great for learning FastAPI and building RESTful APIs with security.

Notifications You must be signed in to change notification settings

MiabhishekPatidar/TaskManagerAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Task Manager API - FastAPI Project

A simple and clean Task Manager API built using FastAPI πŸš€
It allows you to create, view, update, and delete tasks securely using an API key authentication system.


πŸ“š Features

  • βœ… Create a Task
  • βœ… View All Tasks
  • βœ… View Task by ID
  • βœ… Update a Task
  • βœ… Delete a Task
  • βœ… API Key Authentication (header-based security)

πŸš€ Getting Started

1. Clone the Repository

git clone https://github.com/MiabhishekPatidar/TaskManagerAPI.git
cd TaskManagerAPI

2. Setup Virtual Environment

python -m venv venv

Activate the environment:

  • Windows:
    venv\Scripts\activate
  • Mac/Linux:
    source venv/bin/activate

3. Install Dependencies

pip install fastapi uvicorn

4. Run the Server

uvicorn app.main:app --reload

Server will start at:
πŸ‘‰ http://127.0.0.1:8000


πŸ” API Key Authentication

All API requests must include an API Key in the headers.

Example Header:

x-api-key: your-secret-api-key

⚑ Note: The API key is hardcoded in the backend for now. Update it in the code if needed.


πŸ›  API Endpoints

Method Endpoint Description
POST /tasks/ Create a new task
GET /tasks/ Get all tasks
GET /tasks/{task_id} Get task by ID
PUT /tasks/{task_id} Update task by ID
DELETE /tasks/{task_id} Delete task by ID

βœ… All endpoints require the x-api-key header.


πŸ›  Technologies Used

  • FastAPI
  • Uvicorn
  • Python 3.12+

🌟 Author


πŸ“œ License

This project is open source and free to use!


About

A FastAPI-based task manager API that allows users to create, view, update, and delete tasks. It features API key authentication for secure access and uses SQLite for storage. Great for learning FastAPI and building RESTful APIs with security.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages