Welcome

Flask-Jeroboam: a durable Flask for fine APIs.

Welcome to Flask-Jeroboam’s documentation.

Flask-Jeroboam is a Flask extension modelled after FastAPI. Like the former, it uses Pydantic to provide easy-to-configure data validation in request parsing and response serialization, as well as OpenAPI-compliant documentation auto-generation.

Start with Installation, then jump right in with our Getting Started Guide. Next, the In-depth Features Tour dive deep into how to use the extension, while the Tutorial walks you through a comprehensive example. Finally, the API section gives you details on the extension’s internals.

Note

This documentation assumes a certain familiarity with Flask and Pydantic. If you’re new to either, please refer to their respective documentation. They are both fantastic.

User’s Guide

This guide will walk you through how to use Flask-Jeroboam.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Additional Notes