Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

Task Management CRUD API

Python FastAPI License

A lightweight, in-memory RESTful API built to manage a to-do list. I have developed this portfolio project while doing FastAPI - The Complete Course 2026 (Beginner + Advanced) on Udemy as practice. 

The API demonstrates foundational backend concepts, including full CRUD operations (Create, Read, Update, Delete)[cite: 1], RESTful path routing, and strict HTTP status code validation.

Quick Start

To run this API locally, clone the repository and execute the following command in your terminal. (Note: Requires uvicorn and fastapi to be installed).

uvicorn main:app --reload

The server will boot up instantly on http://localhost:8000.


API Reference

HTTP Method Endpoint Description Expected Status Codes
GET / Returns API metadata. 200 OK
GET /health Server heartbeat check. 200 OK
GET /tasks Retrieves all tasks. 200 OK
GET /tasks/{id} Retrieves a single task. 200 OK, 404 Not Found
POST /tasks Creates a new task. 201 Created, 400 Bad Request
PUT /tasks/{id} Updates an existing task. 200 OK, 400 Bad Request, 404 Not Found
DELETE /tasks/{id} Deletes a task. 204 No Content, 404 Not Found

Testing the API

Example curl Request:

curl -i http://localhost:8000/

Expected Response:

HTTP/1.1 200 OK
server: uvicorn
content-length: 56
content-type: application/json

{"name":"Task API","version":"1.0","endpoints":["/tasks"]}

Interactive Documentation (Swagger UI)

Because this API is built with FastAPI, OpenAPI interactive documentation is generated automatically.

You can test the full CRUD cycle directly from your browser without using the terminal by navigating to: http://localhost:8000/docs

Screenshots

Swagger UI Screenshot 1 Swagger UI Screenshot 2

About

A RESTful Task Management API built with FastAPI. Features full CRUD operations, strict HTTP status validation, and automated Swagger UI documentation.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages