David-Lazaro-Fernandez / fastapi-on-azure-functions

A sample to run a FastAPI app on Azure Functions

page_type	languages	products	description	title	author	urlFragment
sample	python	azure azure-functions	This is a sample Azure Function app created with the FastAPI framework.	Using FastAPI Framework with Azure Functions	shreyabatra4, vrdmr	azure-functions-python-create-fastapi-app

Using FastAPI Framework with Azure Functions

Azure Functions supports WSGI and ASGI-compatible frameworks with HTTP-triggered Python functions. This can be helpful if you are familiar with a particular framework, or if you have existing code you would like to reuse to create the Function app. The following is an example of creating an Azure Function app using Fast API.

Prerequisites

You can develop and deploy a function app using either Visual Studio Code or the Azure CLI. Make sure you have the required prerequisites for your preferred environment:

• Prerequisites for VS Code
• Prerequisites for Azure CLI

Setup

Clone or download this sample's repository, and open the fastapi-on-azure-functions folder in Visual Studio Code or your preferred editor (if you're using the Azure CLI).

Using FastAPI Framework in an Azure Function App

The code in the sample folder has already been updated to support use of the FastAPI. Let's walk through the changed files.

The requirements.txt file has an additional dependency of the fastapi module:

azure-functions
fastapi

The file host.json includes the a routePrefix key with a value of empty string.

{
  "version": "2.0",
  "extensions": {
    "http": {
        "routePrefix": ""
    }
  }
}

Inside the WrapperFunction folder, the file function.json includes a route key in the bindings:

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ],
      "route": "{*route}"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    }
  ]
}

In that same folder, the __init__.py file uses AsgiMiddleware to redirect invocations to a FastAPI app with two routes defined.

import logging
import azure.functions as func
from FastAPIApp import app  # Main API application


@app.get("/sample")
async def index():
    return {
        "info": "Try /hello/Shivani for parameterized route.",
    }


@app.get("/hello/{name}")
async def get_name(name: str):
    return {
        "name": name,
    }

async def main(req: func.HttpRequest, context: func.Context) -> func.HttpResponse:
    """Each request is redirected to the ASGI handler."""
    return await func.AsgiMiddleware(app).handle_async(req, context)

Running the sample

Testing locally

First run the command below to install the necessary requirements.

python3 -m pip install -r requirements.txt

If you are using VS Code for development, follow the instructions for running a function locally. Otherwise, follow these instructions for using Core Tools commands directly to run the function locally.

Once the function is running, test the function at the local URL displayed in the Terminal panel:

Functions:
        WrapperFunction: [GET,POST] http://localhost:7071/{*route}

Try out URLs corresponding to the handlers in the app, both the simple path and the parameterized path:

http://localhost:7071/sample
http://localhost:7071/hello/YourName

Deploying to Azure

There are three main ways to deploy this to Azure:

• Deploy with the VS Code Azure Functions extension.
• Deploy with the Azure CLI.
• Deploy with the Azure Developer CLI: After installing the azd tool, run azd up in the root of the project. You can also run azd pipeline config to set up a CI/CD pipeline for deployment.

Testing in Azure

Once deployed, test different paths on the deployed URL, using either a browser or a tool like Postman.

http://<FunctionAppName>.azurewebsites.net/sample
http://<FunctionAppName>.azurewebsites.net/hello/Foo

If you get an error about handle_async not being defined, that is likely because the Azure Functions runtime doesn't yet have the latest version of azure-functions. To work around that for now, add an environment value with the name PYTHON_ISOLATE_WORKER_DEPENDENCIES and value of 1. That environment variable ensures that the packages in your requirements.txt are installed in a separate virtual environment than the packages of the functions runtime.

Conclusion and Next Steps

Now you have a simple Azure Function App using the FastAPI framework, and you can continue building on it to develop more sophisticated applications.

To learn more about leveraging WSGI and ASGI-compatible frameworks, see Web frameworks.