d9aa8303a7
Adds a full public REST API at /api/v1/ with 32 endpoints covering library, search, downloads, wishlist, watchlist, playlists, system status, and settings. Includes API key authentication (Bearer token), per-endpoint rate limiting, and consistent JSON response format. API keys can be generated and managed from the Settings page. No changes to existing functionality — the API delegates to the same backend services the web UI uses.
51 lines
1.4 KiB
Python
51 lines
1.4 KiB
Python
"""
|
|
Shared response helpers for the SoulSync public API.
|
|
"""
|
|
|
|
from flask import jsonify
|
|
|
|
|
|
def api_success(data, pagination=None, status=200):
|
|
"""Wrap a successful response in the standard envelope."""
|
|
return jsonify({
|
|
"success": True,
|
|
"data": data,
|
|
"error": None,
|
|
"pagination": pagination,
|
|
}), status
|
|
|
|
|
|
def api_error(code, message, status=400):
|
|
"""Wrap an error response in the standard envelope."""
|
|
return jsonify({
|
|
"success": False,
|
|
"data": None,
|
|
"error": {"code": code, "message": message},
|
|
"pagination": None,
|
|
}), status
|
|
|
|
|
|
def build_pagination(page, limit, total):
|
|
"""Build a pagination dict from page/limit/total."""
|
|
total_pages = max(1, (total + limit - 1) // limit)
|
|
return {
|
|
"page": page,
|
|
"limit": limit,
|
|
"total": total,
|
|
"total_pages": total_pages,
|
|
"has_next": page < total_pages,
|
|
"has_prev": page > 1,
|
|
}
|
|
|
|
|
|
def parse_pagination(request, default_limit=50, max_limit=200):
|
|
"""Extract and validate page/limit from a Flask request."""
|
|
try:
|
|
page = max(1, int(request.args.get("page", 1)))
|
|
except (ValueError, TypeError):
|
|
page = 1
|
|
try:
|
|
limit = min(max_limit, max(1, int(request.args.get("limit", default_limit))))
|
|
except (ValueError, TypeError):
|
|
limit = default_limit
|
|
return page, limit
|