Skip to content

API Reference Overview

Welcome to the API Reference section of our documentation. This section provides detailed information about the various classes, functions, and modules that make up our application. Whether you are looking to extend the application, integrate with it, or simply explore its capabilities, this section will guide you through the intricacies of our codebase.

Key Components

Our application's API is comprised of several key components, each serving a specific purpose:

  1. FastCRUD Class: This class is at the heart of our CRUD (Create, Read, Update, Delete) operations. It provides a convenient and efficient way to interact with our database models.

  2. EndpointCreator Class: A utility class for creating and registering CRUD endpoints in a FastAPI application. It simplifies the addition of standard CRUD endpoints to your FastAPI router.

  3. crud_router Function: A function that creates and configures a FastAPI router with CRUD endpoints for a specific model. It's a quick way to add standard CRUD operations to your models.

  4. paginated Module: A utility module for offset pagination related functions.

!!! note "Module Restructured" As of version 0.18.0, pagination utilities have been moved to the core module for better organization. The fastcrud.paginated module is now deprecated but remains available for backward compatibility.

- [Pagination Module Reference](paginated.md)

Usage

Each component is documented with its own dedicated page, where you can find detailed information about its methods, parameters, return types, and usage examples. These pages are designed to provide you with all the information you need to understand and work with our API effectively.

Architecture

For a deeper understanding of how these components fit together, see our Architecture Documentation. This explains FastCRUD's six-level dependency hierarchy, design principles, and how the modules are organized.

Contribution

If you wish to contribute to the development of our API, please refer to our Contributing Guidelines. We welcome contributions of all forms, from bug fixes to feature development.

Feedback

Your feedback is crucial in helping us improve this documentation. If you have any suggestions, corrections, or queries, please reach out to us.

Navigate through each section for detailed documentation of our API components.