Configuration management in FastAPI - Mini Project: Build & Apply

Configuration Management in FastAPI

📖 Scenario: You are building a simple FastAPI web application that needs to manage configuration settings like the app's title and debug mode. These settings should be easy to change in one place and used throughout the app.

🎯 Goal: Build a FastAPI app that loads configuration from a dictionary, uses a config variable to store settings, and applies these settings to the app instance.

📋 What You'll Learn

Create a dictionary called config_data with keys app_title and debug and exact values 'My FastAPI App' and True

Create a variable called config that stores the config_data dictionary

Create a FastAPI app instance called app using the title and debug values from config

Add a root path / that returns a JSON with the app's title from the config

💡 Why This Matters

🌍 Real World

Managing configuration in one place helps keep your FastAPI apps organized and easy to update, especially when deploying to different environments like development and production.

💼 Career

Understanding configuration management is essential for backend developers working with FastAPI or any web framework to build maintainable and scalable applications.

1

Create the configuration data dictionary

Create a dictionary called config_data with these exact entries: 'app_title': 'My FastAPI App' and 'debug': True.

FastAPI

# Create the config_data dictionary with app_title and debug
# Your code here

Hint

Use curly braces {} to create a dictionary with the exact keys and values.

2

Create a config variable to hold the configuration

Create a variable called config and assign it the value of config_data.

FastAPI

config_data = {'app_title': 'My FastAPI App', 'debug': True}
# Assign config_data to config variable
# Your code here

Hint

Simply assign the existing dictionary config_data to a new variable config.

3

Create the FastAPI app using config values

Import FastAPI from fastapi. Then create a FastAPI app instance called app using the title and debug values from the config variable.

FastAPI

config_data = {'app_title': 'My FastAPI App', 'debug': True}
config = config_data

# Import FastAPI and create app with title and debug from config
# Your code here

Hint

Use FastAPI(title=..., debug=...) with values from the config dictionary.

4

Add a root path that returns the app title

Add a path operation for GET / using @app.get("/"). Define a function called read_root that returns a dictionary with the key app_title and the value from config['app_title'].

FastAPI

from fastapi import FastAPI

config_data = {'app_title': 'My FastAPI App', 'debug': True}
config = config_data

app = FastAPI(title=config['app_title'], debug=config['debug'])

# Add root path that returns app_title from config
# Your code here

Hint

Use the @app.get("/") decorator and return a dictionary with the app title from config.

Practice

1. What is the primary purpose of using pydantic.BaseSettings in a FastAPI application?

easy

A. To generate API documentation

B. To manage application configuration using environment variables or .env files

C. To handle HTTP request routing

D. To create database models automatically

Solution

1. Step 1: Understand the role of pydantic.BaseSettings

   BaseSettings is designed to load configuration values from environment variables or .env files.

2. Step 2: Differentiate from other FastAPI features

   Database models, routing, and documentation are handled by other parts of FastAPI, not BaseSettings.

3. Final Answer:

   To manage application configuration using environment variables or .env files -> Option B

4. Quick Check:

   Configuration management = To manage application configuration using environment variables or .env files [OK]

Hint: Remember: BaseSettings is for config, not routing or DB [OK]

Common Mistakes:

• Confusing BaseSettings with database model classes
• Thinking BaseSettings handles API routing
• Assuming BaseSettings generates docs

2. Which of the following is the correct way to define a FastAPI settings class using pydantic.BaseSettings?

easy

A. def Settings(): return BaseSettings(app_name="MyApp")

B. class Settings: app_name = BaseSettings("MyApp")

C. class Settings(BaseModel): app_name: str = "MyApp"

D. class Settings(BaseSettings): app_name: str = "MyApp"

Solution

1. Step 1: Check class inheritance

   The settings class must inherit from BaseSettings to load environment variables.

2. Step 2: Verify attribute definition

   Attributes are defined as class variables with type annotations and default values.

3. Final Answer:

   class Settings(BaseSettings): app_name: str = "MyApp" -> Option D

4. Quick Check:

   Correct inheritance and attribute syntax = class Settings(BaseSettings): app_name: str = "MyApp" [OK]

Hint: Settings class must inherit BaseSettings with typed attributes [OK]

Common Mistakes:

• Using BaseModel instead of BaseSettings
• Defining settings as a function
• Incorrect inheritance or attribute assignment

3. Given this settings class and environment variable API_KEY=secret123 set, what will print(settings.api_key) output?

from pydantic import BaseSettings

class Settings(BaseSettings):
    api_key: str

settings = Settings()

medium

A. '' (empty string)

B. None

C. secret123

D. Raises a validation error

Solution

1. Step 1: Understand environment variable loading

   BaseSettings automatically reads environment variables matching attribute names in uppercase.

2. Step 2: Check if API_KEY is set

   The environment variable API_KEY=secret123 is set, so settings.api_key will be 'secret123'.

3. Final Answer:

   secret123 -> Option C

4. Quick Check:

   Env var API_KEY loads as 'secret123' [OK]

Hint: BaseSettings reads uppercase env vars matching attribute names [OK]

Common Mistakes:

• Assuming missing default means None instead of error
• Thinking attribute names are case-sensitive differently
• Expecting empty string if env var is set

4. Identify the error in this FastAPI settings code snippet:

from pydantic import BaseSettings

class Settings(BaseSettings):
    debug: bool = False

settings = Settings(debug="foo")

medium

A. Passing a string "foo" instead of a boolean causes a validation error

B. Missing environment variable causes failure

C. BaseSettings cannot have default values

D. Class must inherit from BaseModel, not BaseSettings

Solution

1. Step 1: Check type of passed value

   The debug attribute expects a boolean, but the code passes a string "foo".

2. Step 2: Understand Pydantic validation

   Pydantic tries to coerce the string to bool but "foo" is not recognized, causing a ValidationError.

3. Final Answer:

   Passing a string "foo" instead of a boolean causes a validation error -> Option A

4. Quick Check:

   Pydantic rejects invalid bool strings like "foo" [OK]

Hint: Pydantic bool fields reject invalid strings like "foo" [OK]

Common Mistakes:

• Thinking Pydantic converts any string to bool
• Missing environment variable causes failure
• BaseSettings cannot have default values

5. You want to load configuration from a .env file and override some values with environment variables in FastAPI. Which approach correctly achieves this using pydantic.BaseSettings?

hard

A. Create a Settings class inheriting BaseSettings with class Config: env_file = '.env' and place a .env file in the project root; environment variables override .env values automatically

B. Manually read .env file with open() and parse it, then pass values to Settings constructor

C. Use BaseModel instead of BaseSettings and load .env with dotenv package separately

D. Set environment variables only; .env files are not supported by BaseSettings

Solution

1. Step 1: Understand BaseSettings .env support

   BaseSettings loads .env files when env_file='.env' is set in the inner Config class.

2. Step 2: Know environment variable precedence

   Environment variables override .env file values automatically when both exist.

3. Final Answer:

   Create a Settings class inheriting BaseSettings with class Config: env_file = '.env' and place a .env file in the project root; environment variables override .env values automatically -> Option A

4. Quick Check:

   BaseSettings loads .env via Config env_file and env vars override [OK]

Hint: BaseSettings loads .env via Config(env_file='.env'); env vars override .env values [OK]

Common Mistakes:

• Manually parsing .env instead of using BaseSettings Config
• Using BaseModel which lacks .env support
• Thinking .env files are unsupported by BaseSettings