47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
|
# API & Backend Notes
|
||
|
|
|
||
|
|
**API client location:** `lib/core/api/`
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
> Document the backend API base URL, auth method, and overall structure here.
|
||
|
|
|
||
|
|
## Authentication
|
||
|
|
> e.g. Bearer token, JWT, OAuth2 — add details as you discover them
|
||
|
|
|
||
|
|
## Endpoints
|
||
|
|
|
||
|
|
### Auth
|
||
|
|
| Method | Endpoint | Description |
|
||
|
|
|--------|----------|-------------|
|
||
|
|
| POST | `/auth/login` | User login |
|
||
|
|
| POST | `/auth/register` | User registration |
|
||
|
|
| POST | `/auth/logout` | Logout |
|
||
|
|
|
||
|
|
### Events
|
||
|
|
| Method | Endpoint | Description |
|
||
|
|
|--------|----------|-------------|
|
||
|
|
| GET | `/events` | List events |
|
||
|
|
| GET | `/events/:id` | Event detail |
|
||
|
|
| POST | `/events/:id/book` | Book event |
|
||
|
|
|
||
|
|
### Reviews
|
||
|
|
| Method | Endpoint | Description |
|
||
|
|
|--------|----------|-------------|
|
||
|
|
| GET | `/events/:id/reviews` | Get reviews |
|
||
|
|
| POST | `/events/:id/reviews` | Submit review |
|
||
|
|
|
||
|
|
### Gamification
|
||
|
|
| Method | Endpoint | Description |
|
||
|
|
|--------|----------|-------------|
|
||
|
|
| GET | `/leaderboard` | Get leaderboard |
|
||
|
|
| GET | `/users/:id/achievements` | User achievements |
|
||
|
|
|
||
|
|
> Update endpoints above as you explore `lib/core/api/`
|
||
|
|
|
||
|
|
## Error Handling
|
||
|
|
> Document API error codes and how interceptors handle them
|
||
|
|
|
||
|
|
## Related
|
||
|
|
- [[02 - Features/Auth]]
|
||
|
|
- [[02 - Features/Events]]
|