flask-mongo-drf Documentation

Flask-Mongo-DRF is an industrial-grade REST framework for Flask + MongoDB, offering a Django REST Framework-like development experience.

Getting Started

• Getting Started
• Installation
• Quick Start
  • 1. Create Flask app and configure MongoDB
  • 2. Define model and serializer
  • 3. Write ViewSet and register routes
  • 4. Run the app

User Guide

• Models
  • Usage
  • Available Methods
• Serializers
  • Define a Serializer
  • Built-in Field Types
  • Field Options
  • Using Serializers
• Filters
  • Define a FilterSet
  • Usage in ViewSet
  • Built-in Filter Types
  • Supported Lookup Expressions
• Pagination
  • Custom Pagination
  • Use in ViewSet
  • Request Example
• ViewSets
  • Basic Usage
  • Available Actions
  • Custom Aggregation
  • Route Registration
• Routing
  • Parameters
  • Example

Advanced Topics

• Multi-Database Support
  • Configuration Example
  • Use in Model
• Custom Serializers
  • Custom Field
  • Use in Serializer
• Aggregation
  • Example
• Error Handling
  • Exception Classes
  • Response Format
  • Custom Exception

API Reference

• flask_mongo_drf package
  • Subpackages
  • Submodules
  • flask_mongo_drf.mongo_decorators module
  • flask_mongo_drf.mongo_exceptions module
  • flask_mongo_drf.mongo_filters module
  • flask_mongo_drf.mongo_models module
  • flask_mongo_drf.mongo_paginations module
  • flask_mongo_drf.mongo_responses module
  • flask_mongo_drf.mongo_serializers module
  • flask_mongo_drf.mongo_swagger module
  • flask_mongo_drf.mongo_viewsets module
  • Module contents
• flask_mongo_drf.contrib package
  • Submodules
  • flask_mongo_drf.contrib.mongodb_manager module
  • Module contents
• flask_mongo_drf
  • flask_mongo_drf package

Development

• Contributing
  • Development Setup
  • Run Tests
  • Code Style
• Testing
  • Run Tests
  • Example Test
• Changelog
  • v1.0.0 (2026-04-10)

Indices and tables

• Index

• Module Index

• Search Page