tomjgooding/fastapi-simple-todo-mock

A simple mock To-Do List API using FastAPI and Mongita

FastAPI Simple To-Do List Mock

A simple mock To-Do List API using FastAPI and Mongita.

Table of Contents

• About
  • Built With
• Getting Started
  • Installation
• Usage
  • Run the Server
  • Interact From the Browser (Swagger UI)
  • Interact From the Command Line (HTTPie)
• Acknowledgements
• Licence

About

A simple mock To-Do List API using FastAPI and Mongita, with basic CRUD operations allowing you to create, update and delete tasks.

Built With

• Python
• FastAPI
• Mongita

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/TomJGooding/fastapi-simple-todo-mock.git

2. Install the requirements. It is recommended to first create a virtual environment.

   python3 -m pip install -r requirements.txt

Usage

Run the Server

Run the Uvicorn server with:

uvicorn main:app

Interact From the Browser (Swagger UI)

Swagger UI is a browser-based tool for interacting with REST APIs, and FastAPI creates this user interface for the API automatically.

Open your browser at http://localhost:8000/docs

For example, to create a new task:

1. Expand the POST /todos Create Task item.
2. Click the Try it out button, which will allow you to fill the parameters.
3. Then click the Execute button. The user interface will communicate with your API, send the parameters, get the results and show them on the screen.

Interact From the Command Line (HTTPie)

HTTPie is a command-line HTTP client for interacting with APIs & HTTP servers.

You will need to have the FastAPI server running in the background.

For example, create a new task with:

http POST localhost:8000/todos id=1 title="Water the plants" complete=False

Acknowledgements

• The Python REST APIs With FastAPI video course by Real Python for getting started with FastAPI

Licence

Licensed under the GNU General Public License v3.0.