Overview

The Data Forge API provides a unified, flexible framework for managing data across web applications, mobile apps, and web services. This comprehensive library empowers developers to:

Efficiently manage data operations using SQL and Entity classes.
Perform advanced tasks via customizable Task classes.
Provide secure guest access with GuestTask methods for unauthenticated endpoints.
Seamlessly integrate features like custom filters, sorting, and data aggregation.

Key Features

1. Query Class Framework

Provides a powerful and reusable query builder for dynamic SQL generation.
Supports advanced features like dynamic filtering, grouping, and sorting.
Enables modular query construction with features like union for merging multiple queries.

2. SQL Class Framework

Reusable and flexible SQL methods tailored for specific data operations.
Centralized query definitions, promoting consistency and reducing redundancy.

3. Entity Class Framework

Encapsulates business logic with ORM-like features, including lazy-loading support.
Simplifies complex data relationships while maintaining flexibility in entity design.
Example Use Case: Create interconnected modules like Users, Properties, and Tenants with reusable entities.

4. Task Classes

Handle custom operations like Save, Update, and Delete actions.
Simplify preparation of complex workflows, such as dynamic form data for edit/detail pages.
Example Use Case: Create a "Save and Notify" workflow for tenant updates.

5. GuestTask Methods

Prefixed with guest to distinguish unauthenticated methods from secure ones.
Limits data exposure while enabling guest-level operations for public endpoints.

6. Advanced Query Customization

Dynamic filters, sorting, and column selection for query-level flexibility.
Structured JSON API responses to streamline data presentation for frontend integrations.
Example Use Case: Fetch dynamic dropdown options for frontend forms with pre-applied filters.

7. Authentication Integration

Securely restrict endpoints to authenticated users while supporting role-based data access.
Example Use Case: Allow tenants to access their property details while hiding owner-specific data.

Why Use Data Forge?

Data Forge is the ultimate tool for developers looking to:

Streamline data operations by bridging SQL and application logic.
Build modular, scalable applications with minimal repetitive coding.
Simplify complex workflows while maintaining performance and flexibility.

Whether you're developing a small-scale application or a large-scale enterprise project, Data Forge adapts to your needs, enabling you to focus on building robust and maintainable solutions.

The documentation explores each feature and API endpoint in detail, starting with foundational concepts and extending to advanced use cases. Let’s unlock the full potential of Data Forge together!