How setting endpoint access permissions for FastAPI-Radar

[cybors]

can i set auth for radar endpoint

[pahalie]

can't you initialize a separate radar app with middleware to parse basic auth and do main_app.mount("/__radar", radar_app) ?

[doganarif]

✅ Implemented in v0.3.4

This feature has been implemented and released! 🎉

Implementation

Added auth_dependency parameter to the Radar class that accepts any FastAPI dependency function. When provided, both the dashboard UI and API endpoints require authentication.

Usage

HTTP Basic Authentication:

from fastapi import Depends, HTTPException, status
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi_radar import Radar
import secrets

security = HTTPBasic()

def verify_credentials(credentials: HTTPBasicCredentials = Depends(security)):
    correct_username = secrets.compare_digest(credentials.username, "admin")
    correct_password = secrets.compare_digest(credentials.password, "secret")
    if not (correct_username and correct_password):
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Invalid credentials",
            headers={"WWW-Authenticate": "Basic"},
        )
    return credentials

radar = Radar(app, auth_dependency=verify_credentials)

Features

✅ Maximum Flexibility - Works with any FastAPI dependency (OAuth2, JWT, API keys, custom)
✅ Zero Overhead - When auth_dependency=None, behaves exactly as before
✅ Backward Compatible - No breaking changes
✅ Well Documented - Comprehensive examples in README and example files

Examples

Three example files demonstrating different auth methods:

• example_auth_app.py - HTTP Basic authentication
• example_bearer_auth.py - Bearer token authentication
• example_custom_auth.py - Custom API key authentication

Links

• PR: feat: add endpoint access permissions via auth_dependency parameter #38
• Release: https://github.com/doganarif/fastapi-radar/releases/tag/v0.3.4
• PyPI: https://pypi.org/project/fastapi-radar/0.3.4/
• Documentation: See README for detailed examples

Installation

pip install --upgrade fastapi-radar

Thanks for the suggestion! 🙏