Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .codex
Empty file.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,22 @@ TeachLink Backend provides secure and scalable APIs to power features such as:
- 📊 Analytics and activity insights
- 🧾 DAO integration for content moderation and governance

## 🔀 API Versioning

TeachLink uses a header-based API versioning strategy for application endpoints.

- Send `X-API-Version: 1` with every versioned API request.
- Supported versions are configured through `API_SUPPORTED_VERSIONS` and default to `1`.
- `API_DEFAULT_VERSION` controls the currently active route version and defaults to `1`.
- Health checks, metrics endpoints, the root route, and payment webhooks are version-neutral.
- Requests with a missing or invalid API version header return a client error before the request reaches the controller.

Example:

```bash
curl -H "X-API-Version: 1" http://localhost:3000/users
```

## 📊 Architecture

## ⚙️ Tech Stack
Expand Down
Loading
Loading