The API Reference covers every public class, function, and configuration option in the JustAPI framework.
Core Classes
| Class |
Description |
| JustAPIApp |
Main application class. Register routes, middleware, and plugins. |
| APIRouter |
Modular router for grouping related routes. |
| Request |
Incoming HTTP request with zero-copy access. |
| Response |
Response classes for different content types. |
| BackgroundTasks |
Post-response background task execution. |
| UploadFile |
Uploaded file representation. |
| Database |
Connection pool and query interface. |
| PyScheduler |
Cron-based periodic task scheduler. |
| Session |
Agent session state management. |
| JustAPITestClient |
In-process HTTP test client. |
Functions & Decorators
| Module |
Description |
| Routing |
@app.get(), @app.post(), @app.put(), @app.patch(), @app.delete() |
| Dependency Injection |
Depends(), Path(), Query(), Header(), Cookie(), Body(), File(), Form() |
| Exceptions |
HTTPException, RequestValidationError |
| Schema & Validation |
Schema, Field(), validate_value() |
| WebSockets |
@app.websocket(), WebSocket class |
| Plugins |
Plugin hooks: build(), on_startup(), on_shutdown() |
Quick Links