24 lines
521 B
Markdown
24 lines
521 B
Markdown
# API Documentation
|
|
|
|
This folder contains full backend API documentation for `BenyaMessenger`.
|
|
|
|
- Main REST reference: [api-reference.md](./api-reference.md)
|
|
- Realtime/WebSocket reference: [realtime.md](./realtime.md)
|
|
|
|
Base URL:
|
|
|
|
- Local: `http://localhost:8000`
|
|
- Prefix for API v1: `/api/v1`
|
|
- Full base path for REST endpoints: `/api/v1/...`
|
|
|
|
Built-in health endpoints:
|
|
|
|
- `GET /health`
|
|
- `GET /health/live`
|
|
- `GET /health/ready`
|
|
|
|
Auth for protected REST endpoints:
|
|
|
|
- Header: `Authorization: Bearer <access_token>`
|
|
|