p3a: add API Reference overview — class/functions index with links
swadhinbiswas committed 3 months ago
70f3afd
1 parent 707cadd
commit 70f3afd
1 file changed
+38 -0
Showing 1 changed file+38-0
▼docs_site/src/content/docs/api-reference/index.md
+38-0
| @@ -0,0 +1,38 @@ | ||
1 | +--- | |
2 | +title: API Reference Overview | |
3 | +description: Complete reference for all JustAPI classes, functions, and parameters. | |
4 | +--- | |
5 | + | |
6 | +The API Reference covers every public class, function, and configuration option in the JustAPI framework. | |
7 | + | |
8 | +## Core Classes | |
9 | + | |
10 | +| Class | Description | | |
11 | +|---|---| | |
12 | +| [JustAPIApp](/api-reference/justapiapp/) | Main application class. Register routes, middleware, and plugins. | | |
13 | +| [APIRouter](/api-reference/apirouter/) | Modular router for grouping related routes. | | |
14 | +| [Request](/api-reference/request/) | Incoming HTTP request with zero-copy access. | | |
15 | +| [Response](/api-reference/responses/) | Response classes for different content types. | | |
16 | +| [BackgroundTasks](/api-reference/background-tasks/) | Post-response background task execution. | | |
17 | +| [UploadFile](/api-reference/uploadfile/) | Uploaded file representation. | | |
18 | +| [Database](/api-reference/database/) | Connection pool and query interface. | | |
19 | +| [PyScheduler](/api-reference/scheduler/) | Cron-based periodic task scheduler. | | |
20 | +| [Session](/api-reference/session/) | Agent session state management. | | |
21 | +| [JustAPITestClient](/api-reference/testing-client/) | In-process HTTP test client. | | |
22 | + | |
23 | +## Functions & Decorators | |
24 | + | |
25 | +| Module | Description | | |
26 | +|---|---| | |
27 | +| [Routing](/api-reference/routing/) | `@app.get()`, `@app.post()`, `@app.put()`, `@app.patch()`, `@app.delete()` | | |
28 | +| [Dependency Injection](/api-reference/dependency-injection/) | `Depends()`, `Path()`, `Query()`, `Header()`, `Cookie()`, `Body()`, `File()`, `Form()` | | |
29 | +| [Exceptions](/api-reference/exceptions/) | `HTTPException`, `RequestValidationError` | | |
30 | +| [Schema & Validation](/api-reference/schema-validation/) | `Schema`, `Field()`, `validate_value()` | | |
31 | +| [WebSockets](/api-reference/websockets/) | `@app.websocket()`, `WebSocket` class | | |
32 | +| [Plugins](/api-reference/plugins/) | Plugin hooks: `build()`, `on_startup()`, `on_shutdown()` | | |
33 | + | |
34 | +## Quick Links | |
35 | + | |
36 | +- [Getting Started](/getting-started/overview/) — Quick introduction | |
37 | +- [Tutorials](/tutorials/hello-world/) — Step-by-step guides | |
38 | +- [Source Code](https://github.com/swadhinbiswas/JustAPI) — GitHub repository | |
0 | 39 | |