FastAPI Tutorial: Construct APIs with Python in Minutes

June 14, 2024

Picture by Writer

FastAPI is a well-liked net framework for constructing APIs with Python. It is tremendous easy to study and is beloved by builders.

FastAPI leverages Python kind hints and relies on Pydantic. This makes it easy to outline information fashions and request/response schemas. The framework routinely validates request information in opposition to these schemas, lowering potential errors. It additionally natively helps asynchronous endpoints, making it simpler to construct performant APIs that may deal with I/O-bound operations effectively.

This tutorial will train you how one can construct your first API with FastAPI. From organising your improvement atmosphere to constructing an API for a easy machine studying app, this tutorial takes you thru all of the steps: defining information fashions, API endpoints, dealing with requests, and extra. By the tip of this tutorial, you’ll have a great understanding of how one can use FastAPI to construct APIs shortly and effectively. So let’s get began.

Step 1: Set Up the Atmosphere

FastAPI requires Python 3.7 or later. So be sure to have a latest model of Python put in. Within the challenge listing, create and activate a devoted digital atmosphere for the challenge:

$ python3 -m venv v1
$ supply v1/bin/activate

The above command to activate the digital atmosphere works when you’re on Linux or MacOS. If you happen to’re a Home windows person, verify the docs to create and activate digital environments.

Subsequent, set up the required packages. You’ll be able to set up FastAPI and uvicorn utilizing pip:

$ pip3 set up fastapi uvicorn

This installs FastAPI and all of the required dependencies as nicely uvicorn, the server that we’ll use to run and take a look at the API that we construct. As a result of we’ll construct a easy machine studying mannequin utilizing scikit-learn, set up it in your challenge atmosphere as nicely:

$ pip3 set up scikit-learn

With the installations out of the best way, we will get to coding! Yow will discover the code on GitHub.

Step 2: Create a FastAPI App

Create a predominant.py file within the challenge listing. Step one is to create a FastAPI app occasion like so:

# Create a FastAPI app
# Root endpoint returns the app description

from fastapi import FastAPI

app = FastAPI()

The Iris dataset is among the toy datasets that you simply work with when beginning out with information science. It has 150 information data, 4 options, and a goal label (species of Iris flowers). To maintain issues easy, let’s create an API to foretell the Iris species.

Within the coming steps, we’ll construct a logistic regression mannequin and create an API endpoint for prediction. After you’ve constructed the mannequin and outlined the /predict/ API endpoint, it’s best to have the ability to make a POST request to the API with the enter options and obtain the anticipated species as a response.

Iris Prediction API | Picture by Writer

Simply so it’s useful, let’s additionally outline a root endpoint which returns the outline of the app that we’re constructing. To take action, we outline the get_app_description perform and create the foundation endpoint with the @app decorator like so:

# Outline a perform to return an outline of the app
def get_app_description():
	return (
    	"Welcome to the Iris Species Prediction API!"
    	"This API permits you to predict the species of an iris flower based mostly on its sepal and petal measurements."
    	"Use the '/predict/' endpoint with a POST request to make predictions."
    	"Instance utilization: POST to '/predict/' with JSON information containing sepal_length, sepal_width, petal_length, and petal_width."
	)

# Outline the foundation endpoint to return the app description
@app.get("https://www.kdnuggets.com/")
async def root():
	return {"message": get_app_description()}

Sending a GET request to the foundation endpoint returns the outline.

Step 3: Construct a Logistic Regression Classifier

To this point we’ve instantiated a FastAPI app and have outlined a root endpoint. It’s now time to do the next:

Construct a machine studying mannequin. We’ll use a logistic regression classifier. If you happen to’d wish to study extra about logistics regression, learn Constructing Predictive Fashions: Logistic Regression in Python.
Outline a prediction perform that receives the enter options and makes use of the machine studying mannequin to make a prediction for the species (one in all setosa, versicolor, and virginica).

Logistic Regression Classifier | Picture by Writer

We construct a easy logistic regression classifier from scikit-learn and outline the predict_species perform as proven:

# Construct a logistic regression classifier
from sklearn.datasets import load_iris
from sklearn.linear_model import LogisticRegression

# Load the Iris dataset
iris = load_iris()
X, y = iris.information, iris.goal

# Practice a logistic regression mannequin
mannequin = LogisticRegression()
mannequin.match(X, y)

# Outline a perform to foretell the species
def predict_species(sepal_length, sepal_width, petal_length, petal_width):
	options = [[sepal_length, sepal_width, petal_length, petal_width]]
	prediction = mannequin.predict(options)
	return iris.target_names[prediction[0]]

Step 4: Outline Pydantic Mannequin for Enter Knowledge

Subsequent, we should always mannequin the information that we ship within the POST request. Right here the enter options are the size and width of the sepals and petals—all floating level values. To mannequin this, we create an IrisData class that inherits from the Pydantic BaseModel class like so:

# Outline the Pydantic mannequin in your enter information
from pydantic import BaseModel

class IrisData(BaseModel):
	sepal_length: float
	sepal_width: float
	petal_length: float
	petal_width: float

If you happen to want a fast tutorial on utilizing Pydantic for information modeling and validation, learn Pydantic Tutorial: Knowledge Validation in Python Made Tremendous Easy.

Step 5: Create an API Endpoint

Now that we’ve constructed the classifier and have outlined the predict_species perform prepared, we will create the API endpoint for prediction. Like earlier, we will use the @app decorator to outline the /predict/ endpoint that accepts a POST request and returns the anticipated species:

# Create API endpoint
@app.submit("/predict/")
async def predict_species_api(iris_data: IrisData):
	species = predict_species(iris_data.sepal_length, iris_data.sepal_width, iris_data.petal_length, iris_data.petal_width)
	return {"species": species}

And it’s time to run the app!

Step 6: Run the App

You’ll be able to run the app with the next command:

$ uvicorn predominant:app --reload

Right here predominant is the title of the module and app is the FastAPI occasion. The --reload flag ensures that the app reloads if there are any modifications within the supply code.

Upon operating the command, it’s best to see comparable INFO messages:

INFO: 	Will look ahead to modifications in these directories: ['/home/balapriya/fastapi-tutorial']
INFO: 	Uvicorn operating on http://127.0.0.1:8000 (Press CTRL+C to stop)
INFO: 	Began reloader course of [11243] utilizing WatchFiles
INFO: 	Began server course of [11245]
INFO: 	Ready for utility startup.
INFO: 	Utility startup full.
…
…

If you happen to navigate to “http://127.0.0.1:8000″(localhost), it’s best to see the app description:

App Working on localhost

Step 7: Check the API

Now you can ship POST requests to the /predict/ endpoint with the sepal and petal measurements—with legitimate values—and get the anticipated species. You should utilize a command-line utility like cURL. Right here’s an instance:

curl -X 'POST' 
  'http://localhost:8000/predict/' 
  -H 'Content material-Sort: utility/json' 
  -d '{
  "sepal_length": 5.1,
  "sepal_width": 3.5,
  "petal_length": 1.4,
  "petal_width": 0.2
}'

For this instance request that is the anticipated output:

Wrapping Up

On this tutorial, we went over constructing an API with FastAPI for a easy classification mannequin. We went by way of modeling the enter information for use within the requests, defining API endpoints, operating the app, and querying the API.

As an train, take an current machine studying mannequin and construct an API on prime of it utilizing FastAPI. Joyful coding!

Bala Priya C is a developer and technical author from India. She likes working on the intersection of math, programming, information science, and content material creation. Her areas of curiosity and experience embody DevOps, information science, and pure language processing. She enjoys studying, writing, coding, and occasional! At present, she’s engaged on studying and sharing her data with the developer neighborhood by authoring tutorials, how-to guides, opinion items, and extra. Bala additionally creates participating useful resource overviews and coding tutorials.

Buy now