feat(auth,privacy,web): step-by-step login, privacy settings persistence, TOTP QR, and API docs
Some checks failed
CI / test (push) Failing after 22s
Some checks failed
CI / test (push) Failing after 22s
This commit is contained in:
23
docs/README.md
Normal file
23
docs/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 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>`
|
||||
|
||||
Reference in New Issue
Block a user