b4cddf41ea
- Fork elmeg-demo codebase for multi-band support - Add data importer infrastructure with base class - Create band-specific importers: - phish.py: Phish.net API v5 - grateful_dead.py: Grateful Stats API - setlistfm.py: Dead & Company, Billy Strings (Setlist.fm) - Add spec-kit configuration for Gemini - Update README with supported bands and architecture
26 lines
891 B
Markdown
26 lines
891 B
Markdown
# Elmeg API Documentation
|
|
|
|
The Elmeg API is built with **FastAPI**, which automatically generates interactive documentation.
|
|
|
|
## Accessing the Docs
|
|
|
|
When the backend server is running locally:
|
|
|
|
- **Swagger UI**: [http://localhost:8000/docs](http://localhost:8000/docs) - Test endpoints directly in the browser.
|
|
- **ReDoc**: [http://localhost:8000/redoc](http://localhost:8000/redoc) - Alternative documentation view.
|
|
|
|
## Authentication
|
|
|
|
Most write operations (POST, PUT, DELETE) require a Bearer Token.
|
|
|
|
1. Use the `/auth/token` endpoint (or login via Frontend) to get a token.
|
|
2. In Swagger UI, click the **Authorize** button and enter the token.
|
|
|
|
## Key Endpoints
|
|
|
|
- `/shows`: CRUD for Shows.
|
|
- `/songs`: CRUD for Songs and Stats.
|
|
- `/attendance`: Manage user attendance.
|
|
- `/social`: Comments and Ratings.
|
|
- `/moderation`: Moderator tools.
|
|
- `/preferences`: User preferences (Wiki Mode).
|