Music Streaming API

1.0.0

RESTful API pro správu hudební streaming služby.

Verzování

Major verzování v url:

Formát verze

• Součástí URL: /v1/users, /v2/users
• Formát: /v{major}/ major - celé číslo

Typy změn

• Breaking change (v1 → v2): Odstranění endpointu, změna odpovědi... (vše co rozbije závislé služby)
• Nová funkcionalita (v1 → v1): Nový endpoint, nové volitelné pole
• Oprava chyby (v1 → v1): Bugfix

Životnost

• Každá major verze podporována 4 měsíce po vytvoření nové
• Deprecated verze označena X-API-Deprecated: true

Formáty dat

Request/Response

• Content-Type: application/json
• Encoding: UTF-8
• DateTime: ISO 8601 (2025-11-03T14:30:00Z)

Stránkování

Query parametry page (od 1) a limit (max 100).

Response:

{
  "data": [...],
  "pagination": { "page": 1, "limit": 20, "total": 150 }
}

Autentizace

JWT Bearer token autentizace:

1. POST /auth/login → získání tokenu
2. Použití: Authorization: Bearer <token>
3. Platnost: 24 hodin

Role

• admin: Plný přístup
• artist: Správa vlastních písní
• user: Správa vlastních playlistů

Zdroje API

Vazby M:N

• User (1:N) → Playlist
• Playlist (M:N) ↔ Song
• Song (M:N) ↔ Artist

Endpointy

Každý zdroj má CRUD operace:

• GET /{resource} - Seznam
• POST /{resource} - Vytvoření
• GET /{resource}/{id} - Detail
• PUT /{resource}/{id} - Aktualizace
• DELETE /{resource}/{id} - Smazání

This is version 1.0.0 of this API documentation. Last update on Nov 15, 2025.