Sending and receiving messages in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of FastAPI in sending and receiving messages?

FastAPI helps create web APIs that can send and receive messages (data) between clients and servers quickly and easily.

beginner

How do you define a POST endpoint in FastAPI to receive a message?

Use the @app.post decorator on a function that accepts a request body, often defined with Pydantic models to validate the message data.

beginner

What is a Pydantic model used for in FastAPI message handling?

It defines the structure and types of the message data to ensure the received data is valid and easy to work with.

beginner

How does FastAPI send a message back to the client?

By returning a Python dictionary or Pydantic model instance from the endpoint function, FastAPI automatically converts it to JSON for the client.

intermediate

Why is asynchronous programming useful in sending and receiving messages with FastAPI?

It allows FastAPI to handle many message requests at the same time without waiting, making the app faster and more efficient.

Which decorator is used in FastAPI to create an endpoint that receives messages via POST?

A @app.post

B @app.get

C @app.put

D @app.delete

The @app.post decorator defines an endpoint that accepts POST requests, commonly used to receive messages.

What does FastAPI automatically convert your returned Python dictionary into?

A JSON

B XML

C Plain text

D HTML

FastAPI converts returned Python dictionaries or Pydantic models into JSON format for client communication.

Which library does FastAPI use to validate and parse incoming message data?

A Marshmallow

B Jsonschema

C Cerberus

D Pydantic

FastAPI uses Pydantic models to validate and parse incoming data automatically.

What keyword allows FastAPI endpoints to handle requests asynchronously?

A yield

B await

C async

D defer

Using 'async' before a function makes it asynchronous, enabling FastAPI to handle multiple requests efficiently.

If you want to receive a JSON message in FastAPI, what type should your endpoint parameter be?

A str

B Pydantic model

C int

D list

Using a Pydantic model as a parameter lets FastAPI parse and validate the JSON message automatically.

Explain how FastAPI handles receiving a message from a client and sending a response back.

Think about how data flows from client to server and back.

Describe why asynchronous functions improve message handling in FastAPI.

Consider what happens when many clients send messages simultaneously.

Practice

1. What is the main purpose of using Pydantic models in FastAPI when sending and receiving messages?

easy

A. To create HTML templates for message display

B. To manage user authentication tokens

C. To handle database connections automatically

D. To clearly define the structure and data types of messages

Solution

1. Step 1: Understand Pydantic's role in FastAPI

   Pydantic models define how data should look, including types and required fields.

2. Step 2: Connect Pydantic to message handling

   Using Pydantic ensures messages sent or received follow a clear, expected format.

3. Final Answer:

   To clearly define the structure and data types of messages -> Option D

4. Quick Check:

   Pydantic models = message structure [OK]

Hint: Pydantic models describe message shape and types [OK]

Common Mistakes:

• Confusing Pydantic with HTML templating
• Thinking Pydantic manages databases
• Assuming Pydantic handles authentication

2. Which of the following is the correct way to declare a POST endpoint in FastAPI that receives a message model named Message?

easy

A. @app.post('/send')\ndef send_message():\n return Message

B. @app.post('/send')\nasync def send_message(msg: Message):\n return msg

C. @app.get('/send')\nasync def send_message(msg: Message):\n return msg

D. @app.put('/send')\nasync def send_message(msg: Message):\n return msg

Solution

1. Step 1: Identify the HTTP method for sending messages

   POST is used to send data to the server, so @app.post is correct.

2. Step 2: Check function signature for receiving a Pydantic model

   Function must accept a parameter typed as Message to receive the message body.

3. Final Answer:

   @app.post('/send')\nasync def send_message(msg: Message):\n return msg -> Option B

4. Quick Check:

   POST + typed param = correct endpoint [OK]

Hint: Use @app.post and typed parameter for message body [OK]

Common Mistakes:

• Using GET instead of POST for sending data
• Missing parameter type annotation
• Using wrong HTTP method like PUT

3. Given this FastAPI endpoint code, what will be the response when sending a POST request with JSON {"text": "Hello"}?

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Message(BaseModel):
    text: str

@app.post('/echo')
async def echo_message(msg: Message):
    return {"message": msg.text.upper()}

medium

A. {"message": "HELLO"}

B. {"message": "Hello"}

C. {"text": "HELLO"}

D. 500 Internal Server Error

Solution

1. Step 1: Understand the input and model

   The input JSON has key "text" with value "Hello", matching Message model.

2. Step 2: Analyze the endpoint return

   The function returns a dict with key "message" and value as msg.text.upper(), which converts "Hello" to "HELLO".

3. Final Answer:

   {"message": "HELLO"} -> Option A

4. Quick Check:

   Uppercase text returned in 'message' key [OK]

Hint: Look for .upper() call on input text [OK]

Common Mistakes:

• Returning original text without uppercasing
• Returning wrong key name in response
• Expecting an error instead of valid response

4. What is wrong with this FastAPI endpoint code for receiving a message?

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Message(BaseModel):
    content: str

@app.post('/receive')
def receive_message(msg: Message):
    return {"received": msg.content}

medium

A. The endpoint function is missing async keyword

B. The parameter msg should be annotated with Request

C. The endpoint must use @app.get instead of @app.post

D. The function must return a Pydantic model instance

Solution

1. Step 1: Check function declaration for FastAPI async support

   FastAPI supports async endpoints; missing async can cause blocking or warnings.

2. Step 2: Verify parameter and decorator correctness

   Parameter is correctly typed as Message; @app.post is correct for receiving data.

3. Final Answer:

   The endpoint function is missing async keyword -> Option A

4. Quick Check:

   Async keyword needed for async endpoints [OK]

Hint: Use async def for FastAPI POST endpoints [OK]

Common Mistakes:

• Using sync def without async in async context
• Wrong HTTP method decorator
• Incorrect parameter type annotation

5. You want to create a FastAPI endpoint that receives a list of messages, each with a text field, and returns a list of all texts in uppercase. Which code snippet correctly implements this?

hard

A. from fastapi import FastAPI
from pydantic import BaseModel
from typing import List

app = FastAPI()

class Message(BaseModel):
text: str

@app.get('/batch')
def batch_messages(msgs: List[Message]):
return [msg.text.upper() for msg in msgs]

B. from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Message(BaseModel):
text: str

@app.post('/batch')
async def batch_messages(msgs: Message):
return [msg.text.upper() for msg in msgs]

C. from fastapi import FastAPI
from pydantic import BaseModel
from typing import List

app = FastAPI()

class Message(BaseModel):
text: str

@app.post('/batch')
async def batch_messages(msgs: List[Message]):
return [msg.text.upper() for msg in msgs]

D. from fastapi import FastAPI
from pydantic import BaseModel
from typing import List

app = FastAPI()

class Message(BaseModel):
text: str

@app.post('/batch')
async def batch_messages(msgs: List[str]):
return [text.upper() for text in msgs]

Solution

1. Step 1: Use List[Message] to receive multiple messages

   Typing msgs as List[Message] allows FastAPI to parse a list of message objects.

2. Step 2: Return uppercase texts from each message

   List comprehension extracts each msg.text and converts it to uppercase correctly.

3. Final Answer:

   Code snippet with List[Message] parameter and async POST endpoint -> Option C

4. Quick Check:

   List of Message + async POST + uppercase list [OK]

Hint: Use List[Message] and async POST for batch message input [OK]

Common Mistakes:

• Using single Message instead of list
• Using GET instead of POST for sending data
• Typing list as List[str] instead of List[Message]