Sentry Answers>FastAPI>

Understand the purpose of Uvicorn in FastAPI applications

Understand the purpose of Uvicorn in FastAPI applications

David Y.

The ProblemJump To Solution

I’m learning to build applications with FastAPI and I keep reading about this thing called Uvicorn that I’m supposed to use. I understand that it needs to be installed alongside FastAPI and I need to use it to run my application, but I don’t get why.

What is Uvicorn doing and why do I need to use it with FastAPI?

The Solution

Uvicorn is a web server. It handles network communication - receiving requests from client applications such as users’ browsers and sending responses to them. It communicates with FastAPI using the Asynchronous Server Gateway Interface (ASGI), a standard API for Python web servers that run asynchronous code. This leaves FastAPI and our application code free to concentrate on the HTTP layer and application logic, without worrying about the low-level details of network connections.

ASGI is the successor to the Web Server Gateway Interface (WSGI), which only supported synchronous code. ASGI-compatible web servers support both asynchronous and synchronous code.

Uvicorn is not the only ASGI-compatible web server implementation. Alternatives include Daphne (used by Django) and Hypercorn. Both these servers can replace Uvicorn, but since FastAPI is built on Uvicorn, Uvicorn is the recommended web server in most situations.

Uvicorn can be used on its own for development, but production deployments should incorporate Gunicorn with Uvicorn workers. You can read more about the optimal number of these workers in our answer here.

  • Community SeriesIdentify, Trace, and Fix Endpoint Regression Issues
  • ResourcesBackend Error Monitoring 101
  • Syntax.fm logo
    Listen to the Syntax Podcast

    Tasty Treats for Web Developers brought to you by Sentry. Web development tips and tricks hosted by Wes Bos and Scott Tolinski

    Listen to Syntax

Loved by over 4 million developers and more than 90,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

© 2024 • Sentry is a registered Trademark
of Functional Software, Inc.