How to Build a REST API with FastAPI: Step-by-Step Tutorial

How to Build a REST API with FastAPI: Step-by-Step Tutorial

TL;DR: Build a REST API by installing FastAPI, defining Pydantic models for data validation, and creating endpoint functions that return JSON responses. Run the application using the built-in Uvicorn server to test your endpoints instantly.

Step 1: Install FastAPI and Uvicorn

Before writing code, ensure your environment is ready. FastAPI requires a modern Python version (3.8+). Open your terminal and run the installation command. Uvicorn is an ASGI server required to run the application. You can install both packages using pip. This setup takes only a few seconds and establishes the core framework for your project. If you are working in a virtual environment, activate it first to keep dependencies isolated. This step is crucial because missing dependencies are the most common source of beginner errors in Python web development. Verify the installation by checking the version number in your terminal. A successful installation means you are ready to create your first API file. Keep your project directory clean by creating a dedicated folder for this tutorial. This organization will help you manage files as your project grows in complexity over time.

If you want to dig deeper, check out our guide on 10 Simple Lifestyle Hacks for a Happier, Healthier You.

Step 2: Create the Main Application File

Create a new Python file named main.py. Import FastAPI from the fastapi package. Initialize the API object by calling the FastAPI class. This object serves as the entry point for all your routes and middleware. Add a simple root endpoint by defining a function decorated with the @app.get("/") decorator. This function should return a dictionary with a greeting message. FastAPI automatically converts Python dictionaries to JSON responses. This automatic serialization saves you from manually handling JSON encoding. The decorator tells FastAPI to map HTTP GET requests to the root path to this specific function. This pattern is consistent across all HTTP methods, making the syntax predictable and easy to learn for developers coming from other frameworks.

Step 3: Define Pydantic Models

Data validation is critical for robust APIs. Import the BaseModel class from Pydantic. Create a class called Item that inherits from BaseModel. Define fields such as name as a string and price as a float. You can set default values for optional fields. FastAPI uses these models to validate incoming request bodies automatically. If the data does not match the schema, FastAPI returns a clear error message before your code even runs. This prevents runtime errors and ensures data integrity. Use type hints in your function signatures to link these models to your endpoints. For example, define a POST endpoint that accepts an Item object. FastAPI parses the JSON body into a Pydantic instance, providing a seamless developer experience.

Step 4: Implement CRUD Endpoints

Expand your API to handle basic CRUD operations. Create a list to store items in memory. Define a GET endpoint to retrieve all items. Define a POST endpoint to create a new item and add it to the list. Define a GET endpoint with a path parameter to retrieve a specific item by ID. Use path parameters by defining them in the route string, such as /items/{item_id}. FastAPI automatically converts the path parameter to the correct type based on your function signature. This automatic type conversion reduces boilerplate code significantly. Ensure each endpoint returns the appropriate HTTP status code. Use 200 for successful GETs and 201 for created resources. Consistent status codes make your API predictable for frontend developers consuming your service.

Step 5: Run and Test the Server

Start the server by running uvicorn main:app --reload in your terminal. The --reload flag restarts the server whenever you save changes to the code, which is invaluable for development. Open your web browser and navigate to http://127.0.0.1:8000/docs