API Routes Generator¶

Automatic CRUD endpoints generation for Edgy models

The API Routes Generator automatically creates complete REST API endpoints for your Edgy models with just a decorator. It generates all standard CRUD operations (Create, Read, Update, Delete, List) with advanced features like filtering, field selection, and pagination.

Key Features¶

• Automatic CRUD Generation: Complete REST endpoints with a single decorator
• Standard Actions: List, Get, Create, Update, Delete, and Export endpoints
• Field Selection: Control response fields with HTTP headers (Fields Selector)
• Advanced Filtering: Query filtering with multiple operators (Query Builder)
• Pagination Support: Built-in pagination for list endpoints
• Ordering: Sort results by any field
• View Transformers: Custom data transformation pipeline
• Admin Routes: Separate endpoints for admin operations
• Full FastAPI Integration: Native FastAPI router generation

Why API Routes Generator vs Manual Routes?¶

Manual FastAPI Routes Problems¶

• Repetitive Code: Every model needs the same CRUD boilerplate
• Inconsistent APIs: Different developers implement different patterns
• Missing Features: Filtering, pagination, field selection require manual implementation
• Maintenance Overhead: Changes to models require updating multiple endpoints

API Routes Generator Advantages¶

• Zero Boilerplate: One decorator generates all endpoints
• Consistent APIs: All models follow the same REST patterns
• Built-in Features: Filtering, pagination, and field selection included
• Type Safety: Automatic Pydantic schema generation from Edgy models
• Extensible: Custom actions and transformers for specialized needs

Quick Example¶

from fastedgy.orm import Model, fields
from fastedgy.api_route_model import api_route_model

@api_route_model()
class User(Model):
    name = fields.CharField(max_length=100)
    email = fields.EmailField()
    age = fields.IntegerField()

    class Meta:
        tablename = "users"

# Automatically generates these endpoints:
# GET /users/          - List all users (with pagination, filtering, ordering)
# POST /users/         - Create a new user
# GET /users/{id}/     - Get a specific user
# PATCH /users/{id}/   - Update a user
# DELETE /users/{id}/  - Delete a user
# GET /users/export    - Export users data

Generated Endpoints¶

For each registered model, the following endpoints are automatically created:

Common Use Cases¶

• CRUD APIs: Quick REST API creation for data models
• Admin Interfaces: Separate admin endpoints with different permissions
• Mobile Apps: Consistent API endpoints with field selection
• Data Export: Built-in export functionality
• Prototyping: Rapid API development during development

Get Started¶

Ready to generate your first API routes? Follow our quick start guide:

Getting Started User Guide