Accepting connections in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does 'accepting connections' mean in FastAPI?

It means the FastAPI app is ready and waiting to receive requests from users or other programs over the network.

beginner

Which command starts a FastAPI app to accept connections?

Using uvicorn main:app --host 0.0.0.0 --port 8000 starts the server and listens for incoming connections on all network interfaces at port 8000.

intermediate

Why do we use --host 0.0.0.0 when running a FastAPI app?

It tells the server to accept connections from any IP address, not just from the local machine.

beginner

What role does Uvicorn play in accepting connections in FastAPI?

Uvicorn is the server that runs the FastAPI app and handles incoming network connections, forwarding requests to the app and sending back responses.

beginner

How can you test if your FastAPI app is accepting connections?

You can open a browser or use a tool like curl to visit the app's URL (e.g., http://localhost:8000) and see if it responds.

What does the command uvicorn main:app --host 0.0.0.0 --port 8000 do?

A Compiles the FastAPI app

B Starts the FastAPI app and listens for connections on all network interfaces at port 8000

C Runs the app only on localhost

D Stops the FastAPI app

This command runs the FastAPI app with Uvicorn, listening on all IP addresses (0.0.0.0) at port 8000.

Why is 0.0.0.0 used as the host when accepting connections?

A To accept connections from any IP address

B To block all connections

C To accept connections only from the local machine

D To accept connections only from a specific IP

0.0.0.0 means the server listens on all network interfaces, allowing connections from anywhere.

Which tool is commonly used to run a FastAPI app and accept connections?

A Flask

B Django

C Uvicorn

D React

Uvicorn is an ASGI server used to run FastAPI apps and handle incoming connections.

How can you check if your FastAPI app is accepting connections?

A By running a database query

B By restarting the computer

C By deleting the app files

D By opening the app URL in a browser or using curl

Visiting the app URL or using curl sends a request to the server to see if it responds.

What happens if you run FastAPI without specifying --host 0.0.0.0?

A The app only accepts connections from localhost

B The app accepts connections from any IP

C The app crashes immediately

D The app runs in debug mode

By default, FastAPI listens only on localhost, so it won't accept external connections.

Explain how FastAPI accepts connections and what role Uvicorn plays in this process.

Think about the server that handles network traffic and the app that processes requests.

Describe how to start a FastAPI app so it accepts connections from other devices on the same network.

Consider the host address and how devices find the app.

Practice

1. What does it mean when a FastAPI app is "accepting connections"?

easy

A. The app is listening for incoming network requests on a specific address and port.

B. The app is sending data to a database.

C. The app is shutting down all network activity.

D. The app is compiling Python code.

Solution

1. Step 1: Understand the term "accepting connections" in networking

   Accepting connections means the app waits and listens for requests from users or other programs on a network address and port.

2. Step 2: Relate to FastAPI app behavior

   FastAPI apps accept connections by running a server that listens on a host and port for incoming HTTP requests.

3. Final Answer:

   The app is listening for incoming network requests on a specific address and port. -> Option A

4. Quick Check:

   Accepting connections = listening on address and port [OK]

Hint: Accepting connections means listening for requests [OK]

Common Mistakes:

• Confusing accepting connections with sending data
• Thinking it means shutting down the app
• Mixing it with code compilation

2. Which of the following is the correct way to start a FastAPI app to accept connections on all network interfaces at port 8000?

easy

A. uvicorn.run(app, host="127.0.0.1", port=8080)

B. uvicorn.run(app, host="0.0.0.0", port=8000)

C. uvicorn.run(app, host="localhost", port=80)

D. uvicorn.run(app, host="192.168.1.1", port=5000)

Solution

1. Step 1: Identify the host for all network interfaces

   The host "0.0.0.0" means the app listens on all network interfaces, allowing external access.

2. Step 2: Check the port number

   Port 8000 is the default port commonly used for FastAPI apps.

3. Final Answer:

   uvicorn.run(app, host="0.0.0.0", port=8000) -> Option B

4. Quick Check:

   Host 0.0.0.0 + port 8000 = correct start command [OK]

Hint: Use host 0.0.0.0 for all interfaces [OK]

Common Mistakes:

• Using localhost instead of 0.0.0.0 for external access
• Choosing wrong port numbers
• Confusing IP addresses with hostnames

3. Given this code snippet, what will happen when you run it?

import uvicorn
from fastapi import FastAPI
app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello World"}

uvicorn.run(app, host="127.0.0.1", port=9000)

medium

A. The app will listen on all interfaces at port 9000 but return an error on root URL.

B. The app will fail to start due to syntax error.

C. The app will listen on localhost at port 9000 and respond with JSON {"message": "Hello World"} on root URL.

D. The app will listen on localhost but on default port 8000.

Solution

1. Step 1: Analyze the uvicorn.run parameters

   The app runs on host "127.0.0.1" (localhost) and port 9000, so it listens only on local machine at port 9000.

2. Step 2: Check the route and response

   The root path "/" returns JSON {"message": "Hello World"} asynchronously, so a GET request to localhost:9000/ returns this JSON.

3. Final Answer:

   The app will listen on localhost at port 9000 and respond with JSON {"message": "Hello World"} on root URL. -> Option C

4. Quick Check:

   Host 127.0.0.1 + port 9000 + root JSON response = B [OK]

Hint: Check host, port, and route response carefully [OK]

Common Mistakes:

• Assuming app listens on all interfaces
• Expecting default port 8000 instead of 9000
• Thinking code has syntax errors

4. You wrote this code to start your FastAPI app but it crashes with an error:

import uvicorn
from fastapi import FastAPI
app = FastAPI()

uvicorn.run(app, host="localhost", port="8000")

What is the likely cause of the error?

medium

A. Missing async keyword before uvicorn.run call.

B. The host "localhost" is invalid and causes the crash.

C. FastAPI app must be run with app.run(), not uvicorn.run().

D. The port number should be an integer, not a string.

Solution

1. Step 1: Check the port argument type

   The port argument must be an integer, but here it is passed as a string "8000" which causes a type error.

2. Step 2: Verify host and method usage

   Host "localhost" is valid, and uvicorn.run is the correct method to start FastAPI apps.

3. Final Answer:

   The port number should be an integer, not a string. -> Option D

4. Quick Check:

   Port must be int, not str [OK]

Hint: Port must be a number, not text [OK]

Common Mistakes:

• Passing port as string instead of int
• Thinking host "localhost" is invalid
• Using wrong method to start app

5. You want your FastAPI app to accept connections only from your local machine and run on port 8080. Which code snippet correctly achieves this and why?

Option A:
uvicorn.run(app, host="0.0.0.0", port=8080)

Option B:
uvicorn.run(app, host="127.0.0.1", port=8080)

Option C:
uvicorn.run(app, host="localhost", port=80)

Option D:
uvicorn.run(app, host="192.168.1.100", port=8080)

hard

A. Option B, because 127.0.0.1 restricts connections to local machine only on port 8080.

B. Option A, because 0.0.0.0 listens on all interfaces including local machine.

C. Option C, because localhost always means local machine and port 80 is standard.

D. Option D, because 192.168.1.100 is the local IP and port 8080 is correct.

Solution

1. Step 1: Understand host IP meanings

   Host "127.0.0.1" means the app listens only on the local machine (loopback interface), blocking external connections.

2. Step 2: Check port number

   Port 8080 is specified correctly and is a valid port for local testing.

3. Step 3: Evaluate other options

   0.0.0.0 listens on all interfaces, allowing external access; localhost on port 80 uses the wrong port; 192.168.1.100 binds to a specific LAN IP which may not restrict to local machine only.

4. Final Answer:

   Option A, because 127.0.0.1 restricts connections to local machine only on port 8080. -> Option A

5. Quick Check:

   Local only = 127.0.0.1 + port 8080 [OK]

Hint: Use 127.0.0.1 for local-only access [OK]

Common Mistakes:

• Choosing 0.0.0.0 for local-only access
• Confusing localhost and 127.0.0.1
• Using wrong port number