Uvicorn server basics in FastAPI - Mini Project: Build & Apply

Uvicorn Server Basics with FastAPI

📖 Scenario: You want to create a simple web server that can respond to visitors with a friendly message. This server will use FastAPI, a popular Python framework, and run on Uvicorn, a fast server for Python web apps.

🎯 Goal: Build a basic FastAPI app and run it using Uvicorn. The app will have one route that returns a welcome message when accessed.

📋 What You'll Learn

Create a FastAPI app instance named app

Define a GET route at path / that returns a JSON message

Set a variable host to "127.0.0.1"

Set a variable port to 8000

Use uvicorn.run() to start the server with the app, host, and port

💡 Why This Matters

🌍 Real World

Web developers use FastAPI with Uvicorn to quickly build and run web APIs that respond to user requests.

💼 Career

Knowing how to set up and run a FastAPI app with Uvicorn is essential for backend developers working with modern Python web frameworks.

1

Create the FastAPI app instance

Import FastAPI from fastapi and create an app instance called app.

FastAPI

from fastapi import FastAPI

# Create the FastAPI app instance named app
# Your code here

Hint

Use app = FastAPI() to create the app instance.

2

Add a GET route for the root path

Define a GET route on app for path "/" that returns a dictionary with the key "message" and value "Hello, Uvicorn!".

FastAPI

from fastapi import FastAPI

app = FastAPI()

# Define a GET route for path "/" that returns {"message": "Hello, Uvicorn!"}
# Your code here

Hint

Use @app.get("/") decorator and define a function that returns the dictionary.

3

Set host and port variables

Create two variables: host set to "127.0.0.1" and port set to 8000.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "Hello, Uvicorn!"}

# Set host to "127.0.0.1" and port to 8000
# Your code here

Hint

Assign the string "127.0.0.1" to host and the number 8000 to port.

4

Run the app with Uvicorn

Import uvicorn and use uvicorn.run() to start the server with app, host, and port.

FastAPI

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "Hello, Uvicorn!"}

host = "127.0.0.1"
port = 8000

# Import uvicorn and run the app with uvicorn.run(app, host=host, port=port)
# Your code here

Hint

Use uvicorn.run(app, host=host, port=port) to start the server.

Practice

1. What is the main purpose of running uvicorn with a FastAPI app?

easy

A. To start a server that handles web requests for the FastAPI app

B. To compile the FastAPI app into an executable file

C. To create a database connection for the FastAPI app

D. To generate API documentation automatically

Solution

1. Step 1: Understand what Uvicorn does

   Uvicorn is an ASGI server that runs your FastAPI app so it can receive and respond to web requests.

2. Step 2: Identify the purpose of running Uvicorn

   Running Uvicorn starts the server that listens for HTTP requests and sends responses from your FastAPI app.

3. Final Answer:

   To start a server that handles web requests for the FastAPI app -> Option A

4. Quick Check:

   Uvicorn runs server = A [OK]

Hint: Remember: Uvicorn runs the server for your app [OK]

Common Mistakes:

• Thinking Uvicorn compiles code
• Confusing server start with database setup
• Assuming Uvicorn generates docs automatically

2. Which of the following is the correct command to run a FastAPI app located in main.py with auto-reload enabled?

easy

A. uvicorn main:app reload

B. uvicorn main:app --reload

C. uvicorn app:main --reload

D. uvicorn main.py --reload

Solution

1. Step 1: Understand Uvicorn command syntax

   The correct syntax is uvicorn module_name:app_variable. Here, the module is main and the app variable is app.

2. Step 2: Check the options for auto-reload

   The option --reload enables auto-reload during development.

3. Final Answer:

   uvicorn main:app --reload -> Option B

4. Quick Check:

   Correct syntax with --reload = D [OK]

Hint: Use module:app format with --reload flag [OK]

Common Mistakes:

• Including .py extension in module name
• Swapping module and app names
• Missing double dashes before reload

3. Given this command: uvicorn app.main:app --host 0.0.0.0 --port 8080, what will be the effect?

medium

A. The app runs on localhost at port 80

B. The app runs only on 127.0.0.1 at port 8080

C. The app runs on all network interfaces at port 8080

D. The app runs on all interfaces at default port 8000

Solution

1. Step 1: Analyze the host option

   The host 0.0.0.0 means the server listens on all network interfaces, not just localhost.

2. Step 2: Analyze the port option

   The port is explicitly set to 8080, so the app will listen on port 8080.

3. Final Answer:

   The app runs on all network interfaces at port 8080 -> Option C

4. Quick Check:

   Host 0.0.0.0 + port 8080 = C [OK]

Hint: 0.0.0.0 means all interfaces, port sets listening port [OK]

Common Mistakes:

• Assuming 0.0.0.0 means localhost only
• Ignoring the port option
• Confusing default port 8000 with specified port

4. You run uvicorn main:app --reload but get an error: ModuleNotFoundError: No module named 'main'. What is the likely cause?

medium

A. The app variable is not named app inside main.py

B. Uvicorn requires Python 2, but you have Python 3

C. The --reload flag is not supported on your system

D. The file main.py is missing or not in the current directory

Solution

1. Step 1: Understand the error message

   The error says the module main cannot be found, meaning Python can't locate main.py.

2. Step 2: Check file location

   If main.py is missing or not in the current directory where the command runs, this error occurs.

3. Final Answer:

   The file main.py is missing or not in the current directory -> Option D

4. Quick Check:

   ModuleNotFoundError means missing file/module = B [OK]

Hint: Check if main.py exists in current folder [OK]

Common Mistakes:

• Assuming app variable name causes ModuleNotFoundError
• Blaming --reload flag for module errors
• Confusing Python version requirements

5. You want to run your FastAPI app with Uvicorn so it reloads on code changes and listens only on localhost at port 5000. Which command is correct?

hard

A. uvicorn app:app --reload --host 127.0.0.1 --port 5000

B. uvicorn app:app --reload --host 0.0.0.0 --port 5000

C. uvicorn app:app --host 127.0.0.1 --port 5000

D. uvicorn app:app --reload --port 127.0.0.1 --host 5000

Solution

1. Step 1: Identify the reload option

   The --reload flag enables auto-reload on code changes, so it must be included.

2. Step 2: Set host and port correctly

   Listening only on localhost means host should be 127.0.0.1. The port must be set to 5000 using --port 5000.

3. Step 3: Check option order and syntax

   Options order does not affect functionality, but the syntax must be correct: --host followed by IP, --port followed by port number.

4. Final Answer:

   uvicorn app:app --reload --host 127.0.0.1 --port 5000 -> Option A

5. Quick Check:

   Reload + localhost + port 5000 = A [OK]

Hint: Use --reload with --host 127.0.0.1 and --port 5000 [OK]

Common Mistakes:

• Using 0.0.0.0 for localhost only
• Swapping host and port values
• Omitting --reload for auto-reload