Skip to content

API Reference

Welcome to the Ascender Framework API Reference. This section provides comprehensive documentation of all public APIs, classes, decorators, and utilities available in the framework.

Auto-Generated Documentation

API documentation is automatically generated from source code docstrings using mkdocstrings. This ensures the documentation stays in sync with the code.

Core APIs

Controllers

Controller decorators, HTTP methods, routing, and response handling.

Dependency Injection

Injectable decorator, providers, inject() function, and the DI container.

CLI Engine

Command-line interface decorators, parameter handling, and CLI classes.

Modules

Module system, AscModule decorator, and module composition.

Application

Application creation, configuration, and lifecycle management.

Data & Validation

Validation

BaseDTO, BaseResponse, field validators, and custom validation rules.

Database

DatabaseEngine, ORM integration, repositories, and database providers.

Testing & Utilities

Testing

Test lifecycle, TestClient, Mixer, MockDependency, and testing utilities.

HTTP

HTTP request/response handling, HTTP client, and utilities.

Microservices

Client proxies, message context, and transport patterns.

Type Definitions

Types

Provider types, route types, module types, and common type definitions.

Usage

To view detailed API documentation, click on any of the categories above. Each page includes:

  • Class/Function Signatures - Full type annotations
  • Docstrings - Detailed descriptions from source code
  • Parameters - Input parameters and their types
  • Return Values - Return types and descriptions
  • Examples - Usage examples where available
  • Source Code - Links to source implementation