Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

API Browser for Flask-DebugToolbar

Project description

Flask-Debug-API is an API Browser for Flask-DebugToolbar.

Injects a form to POST, PUT, PATCH or DELETE to API endpoints and allows debugging SQLAlchemy queries, Werkzeug stack traces, and everything else that Flask-DebugToolbar supports.

Installation

Install with pip

$ pip install Flask-Debug-API

Usage

# Create your app and enable debugging
from flask_todomvc.factory import create_app
from flask_debugtoolbar import DebugToolbarExtension
from flask_debug_api import DebugAPIExtension

app = create_app()
app.debug = True

# Register Flask-DebugToolbar and Flask-Debug-API
DebugToolbarExtension(app)
DebugAPIExtension(app)

# Append Browse API Panel to Flask-DebugToolbar defaults
# (or add explicitly)
config = app.config
panels = list(config['DEBUG_TB_PANELS'])
panels.append('flask_debug_api.BrowseAPIPanel')
config['DEBUG_TB_PANELS'] = panels

# Optional: Change API prefix to custom prefix
# to filter routes in Browse API Panel
# Can leave '' to browse all routes
# (Default is /api)
config['DEBUG_API_PREFIX'] = '/todos'

app.run(port=8000)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Flask-Debug-API-0.1.0.tar.gz (4.5 kB) Copy SHA256 hash SHA256 Source None Aug 7, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page