API Reference
Welcome to the Mifty Framework API Reference. This section provides comprehensive documentation for all core modules, interfaces, and utilities available in the Mifty framework.
Core Modules
The Mifty framework is built around several core modules that provide the foundation for rapid API development:
Base Classes
- BaseController - Abstract controller class with CRUD operations
- BaseService - Abstract service class with business logic
- BaseRepository - Abstract repository class with data access
Interfaces
- IRepository - Repository pattern interface
- IService - Service layer interface
- PaginatedResult - Pagination result interface
- SearchOptions - Search and filtering options
Utilities
- ApiResponse - Standardized API response utilities
- Logger - Logging utilities with Winston
- RequestOptionBuilder - Query parameter validation and parsing
Application Core
Quick Navigation
By Category
Controllers & Routing
Services & Business Logic
Data Access
Utilities
By Use Case
Creating a New Module
- IRepository Interface - Define data access
- BaseRepository - Implement repository
- IService Interface - Define business logic
- BaseService - Implement service
- BaseController - Create API endpoints
Handling Requests
- RequestOptionBuilder - Parse query parameters
- SearchOptions - Handle search and pagination
- ApiResponse - Return standardized responses
Type Definitions
All interfaces and types are fully documented with TypeScript definitions. The framework uses strict typing to ensure type safety and better developer experience.
Examples
Each API reference page includes:
- Complete method signatures
- Parameter descriptions
- Return type information
- Usage examples
- Related methods and classes
Getting Started
If you're new to the Mifty framework, start with:
- App - Understanding the application structure
- BaseController - Creating your first controller
- BaseService - Implementing business logic
- BaseRepository - Data access patterns