mongkok / fastapi-debug-toolbar

A debug toolbar for FastAPI.

Home Page:https://fastapi-debug-toolbar.domake.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FastAPI Debug Toolbar

FastAPI Debug Toolbar

🐞A debug toolbar for FastAPI based on the original django-debug-toolbar.🐞
Swagger UI & GraphQL are supported.

Test Coverage Codacy Package version


Documentation: https://fastapi-debug-toolbar.domake.io


Installation

pip install fastapi-debug-toolbar

Quickstart

Add DebugToolbarMiddleware middleware to your FastAPI application:

from debug_toolbar.middleware import DebugToolbarMiddleware
from fastapi import FastAPI

app = FastAPI(debug=True)
app.add_middleware(DebugToolbarMiddleware)

SQLAlchemy

Please make sure to use the "Dependency Injection" system as described in the FastAPI docs and add the SQLAlchemyPanel to your panel list:

app.add_middleware(
    DebugToolbarMiddleware,
    panels=["debug_toolbar.panels.sqlalchemy.SQLAlchemyPanel"],
)

Tortoise ORM

Add the TortoisePanel to your panel list:

app.add_middleware(
    DebugToolbarMiddleware,
    panels=["debug_toolbar.panels.tortoise.TortoisePanel"],
)

About

A debug toolbar for FastAPI.

https://fastapi-debug-toolbar.domake.io

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 56.1%Language:JavaScript 19.1%Language:HTML 12.9%Language:CSS 11.6%Language:Shell 0.3%