sql2api 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

sql2api/__init__.py

@@ -1,5 +1,5 @@
 """SQL2API - expose SQL databases as a REST API."""
-__version__ = '0.1.0'
+__version__ = '0.3.0'
 
 from .app import create_app  # noqa: E402  (app imports __version__)
 

sql2api/app.py

@@ -1,21 +1,26 @@
 """The Flask application: HTTP routes on top of the store, engine and formatters."""
 import hmac
 import logging
+import math
 
-from flask import Blueprint, Flask, Response, jsonify, redirect, request, url_for
+from flask import Blueprint, Flask, Response, current_app, g, jsonify, redirect, request, url_for
 from flask.json.provider import DefaultJSONProvider
 from werkzeug.exceptions import HTTPException
+from werkzeug.middleware.proxy_fix import ProxyFix
 
-from . import config, engine, openapi, sqltools, store
+from . import config, cors, engine, openapi, pool, sqltools, store
+from . import params as param_rules
 from .errors import ApiError
 from .formats import FORMATTERS, json_default
+from .ratelimit import RateLimiter
 
 log = logging.getLogger('sql2api')
 bp = Blueprint('api', __name__)
 
 # Query-string arguments that control a request rather than supplying query parameters.
-RESERVED_ARGS = {'format', 'page', 'page_size', 'connection_name', 'version'}
+RESERVED_ARGS = {'format', 'page', 'page_size', 'connection_name', 'version', 'timeout'}
 PUBLIC_ENDPOINTS = {'api.index', 'api.favicon', 'api.health', 'api.docs', 'api.openapi_spec'}
+RATE_LIMIT_EXEMPT = {'api.health'}  # so monitoring keeps working while a client is being throttled
 
 
 class JSONProvider(DefaultJSONProvider):
@@ -25,7 +30,15 @@ class JSONProvider(DefaultJSONProvider):
 
 def create_app():
     from . import __version__
+    config.check_settings()
     app = Flask(__name__)
+    hops = config.proxy_hops()
+    if hops:  # behind reverse proxies: take the client address and scheme from their X-Forwarded-* headers
+        app.wsgi_app = ProxyFix(app.wsgi_app, x_for=hops, x_proto=hops, x_host=hops)
+    app.extensions['sql2api_limiter'] = RateLimiter()
+    if config.cors_origins() == '*' and not config.api_key():
+        log.warning('SQL2API_CORS_ORIGINS=* without SQL2API_API_KEY: any website a user visits can call this API '
+                    'from their browser and reach every active connection. Set an API key or list the origins.')
     app.json = JSONProvider(app)
     app.config['SQL2API_VERSION'] = __version__
 
@@ -43,13 +56,25 @@ def create_app():
         return jsonify({'error': 'An error occurred'}), 500
 
     @app.before_request
-    def require_api_key():
-        expected = config.api_key()
-        if expected and request.endpoint not in PUBLIC_ENDPOINTS:
-            # compare_digest rejects non-ASCII str, so compare bytes
-            supplied = request.headers.get('X-API-Key', '').encode('utf-8', 'replace')
-            if not hmac.compare_digest(supplied, expected.encode('utf-8')):
-                return jsonify({'error': 'Unauthorized'}), 401
+    def gate():
+        # Order matters: a browser's preflight cannot carry the API key, and rate limiting comes before the key
+        # check so that guessing keys is throttled too.
+        if cors.is_preflight(request):
+            return cors.preflight_response(request.headers.get('Origin'))
+        limited = check_rate_limit()
+        if limited is not None:
+            return limited
+        if request.endpoint not in PUBLIC_ENDPOINTS and not has_valid_key():
+            return jsonify({'error': 'Unauthorized'}), 401
+
+    @app.after_request
+    def decorate(response):
+        cors.add_headers(response, request.headers.get('Origin'))
+        if g.get('rate_limit'):
+            limit, remaining = g.rate_limit
+            response.headers['X-RateLimit-Limit'] = str(limit)
+            response.headers['X-RateLimit-Remaining'] = str(remaining)
+        return response
 
     app.register_blueprint(bp)
     return app
@@ -59,6 +84,33 @@ def create_app():
 # Request helpers
 # --------------------------------------------------------------------------------------
 
+def check_rate_limit():
+    """Count this request against its client's quota; returns a 429 response when it is over the limit."""
+    limit = config.rate_limit()
+    if limit is None or request.method == 'OPTIONS' or request.endpoint in RATE_LIMIT_EXEMPT:
+        return None
+    count, period = limit
+    client = request.remote_addr or 'unknown'
+    allowed, remaining, retry_after = current_app.extensions['sql2api_limiter'].hit(client, count, period)
+    g.rate_limit = (count, remaining)
+    if allowed:
+        return None
+    response = jsonify({'error': 'Rate limit exceeded', 'retry_after': retry_after})
+    response.status_code = 429
+    response.headers['Retry-After'] = str(retry_after)
+    return response
+
+
+def has_valid_key():
+    """True when no API key is configured, or the request carries the right X-API-Key header."""
+    expected = config.api_key()
+    if not expected:
+        return True
+    # compare_digest rejects non-ASCII str, so compare bytes
+    supplied = request.headers.get('X-API-Key', '').encode('utf-8', 'replace')
+    return hmac.compare_digest(supplied, expected.encode('utf-8'))
+
+
 def get_json_body(required=True):
     data = request.get_json(silent=True)
     if data is None and not required:
@@ -105,6 +157,20 @@ def get_output_format(body=None):
     return output_format
 
 
+def get_timeout(body=None):
+    """Seconds allowed for the query: ?timeout= may lower the server limit but never raise it."""
+    raw = request.args.get('timeout', (body or {}).get('timeout'))
+    if raw in (None, ''):
+        return config.effective_timeout(None)
+    try:
+        value = float(raw)
+    except (TypeError, ValueError):
+        raise ApiError('timeout must be a number of seconds') from None
+    if not math.isfinite(value) or value <= 0:
+        raise ApiError('timeout must be a positive number of seconds')
+    return config.effective_timeout(value)
+
+
 def render(result, output_format, page, page_size):
     response = jsonify({'message': 'No results returned'}) if not result else FORMATTERS[output_format](result)
     response.headers['X-Page'] = str(page)
@@ -126,8 +192,9 @@ def execute_sql_endpoint():
         raise ApiError('Connection name is missing')
     params = get_object(data.get('params'), 'params')
     output_format = get_output_format(data)
+    timeout = get_timeout(data)
     limit, offset, page = get_pagination()
-    result = engine.execute_sql(data['sql'], data['connection_name'], limit, offset, params)
+    result = engine.execute_sql(data['sql'], data['connection_name'], limit, offset, params, timeout)
     return render(result, output_format, page, limit)
 
 
@@ -145,14 +212,16 @@ def run_saved(ref, body, url_params):
 
     raw = {**url_params, **get_object(body.get('params'), 'params'),
            **get_object(body.get('placeholders'), 'placeholders')}
-    params = sqltools.coerce_params(saved.get('query_parameters'), raw)
-    sql = sqltools.fill_placeholders(saved['sql_query'], params)
+    used = set(sqltools.placeholder_names(saved['sql_query']))
+    values = param_rules.resolve(saved.get('query_parameters'), raw, used=used)
+    sql = sqltools.fill_placeholders(saved['sql_query'], values)
     output_format = get_output_format(body)
+    timeout = get_timeout(body)
     limit, offset, page = get_pagination()
 
     entry = {'executed_at': store.now(), 'connection_name': connection_name}
     try:
-        result, elapsed_ms = engine.timed(engine.execute_sql, sql, connection_name, limit, offset, params)
+        result, elapsed_ms = engine.timed(engine.execute_sql, sql, connection_name, limit, offset, values, timeout)
     except ApiError as error:
         store.record_execution(path, number, {**entry, 'status': 'error', 'error': error.message})
         raise
@@ -197,6 +266,11 @@ def save_sql_to_file():
     if not isinstance(tags, (list, str)):
         raise ApiError('tags must be a string or a list')
     query_parameters = get_object(data.get('query_parameters'), 'query_parameters')
+    param_rules.parse_definitions(query_parameters)
+    unused = sorted(set(query_parameters) - set(sqltools.placeholder_names(data['sql_query'])))
+    if unused:
+        raise ApiError(f"query_parameters declares {', '.join(unused)}, which sql_query does not use "
+                       '(write :name in the SQL, or remove the declaration)')
     connection_name = data.get('connection_name')
     if connection_name is not None and not isinstance(connection_name, str):
         raise ApiError('connection_name must be a string')
@@ -256,12 +330,14 @@ def update_connections():
     if not connections or not isinstance(connections, dict):
         raise ApiError('Connections data is missing')
     store.update_connections(connections)
+    pool.close_pooled_connections()  # new settings or credentials must not be served by old connections
     return jsonify({'message': 'Connections updated successfully'}), 200
 
 
 @bp.route('/connections/<name>', methods=['DELETE'])
 def delete_connection(name):
     store.delete_connection(name)
+    pool.close_pooled_connections()  # a removed connection must not keep serving from idle sockets
     return jsonify({'message': f"Connection '{name}' deleted"}), 200
 
 
@@ -285,10 +361,31 @@ def health():
     return jsonify({'status': 'ok', 'version': current_app.config['SQL2API_VERSION']})
 
 
+def describe_saved_queries():
+    """What the OpenAPI document needs to know about each saved query (never its SQL text)."""
+    described = []
+    for name, number, data in store.latest_versions():
+        sql = data.get('sql_query')
+        if not isinstance(sql, str):
+            continue
+        declared = param_rules.read_definitions(data.get('query_parameters'))
+        used = sqltools.placeholder_names(sql)
+        parameters = {}
+        for param in used:  # what the SQL needs, in order; undeclared ones are plain required text
+            parameters[param] = declared.get(param) or param_rules.read_definition({})
+        described.append({'name': name, 'version': number, 'description': data.get('description'),
+                          'tags': data.get('tags'), 'connection_name': data.get('connection_name'),
+                          'parameters': parameters})
+    return described
+
+
 @bp.route('/openapi.json', methods=['GET'])
 def openapi_spec():
     from flask import current_app
-    return jsonify(openapi.build_spec(current_app.config['SQL2API_VERSION']))
+    # The generic API description is public. The list of saved queries (names, descriptions, parameters) is only
+    # shown to callers who could list them anyway, so an API key protects it too.
+    saved = describe_saved_queries() if has_valid_key() else None
+    return jsonify(openapi.build_spec(current_app.config['SQL2API_VERSION'], saved))
 
 
 @bp.route('/docs', methods=['GET'])

sql2api/cli.py

@@ -2,6 +2,7 @@
 import argparse
 import logging
 import os
+import sys
 
 from . import __version__, config, store
 from .app import create_app
@@ -10,7 +11,11 @@ LOOPBACK_HOSTS = ('127.0.0.1', 'localhost', '::1')
 
 
 def _serve(args):
-    app = create_app()
+    try:
+        app = create_app()
+    except ValueError as error:  # a malformed setting, e.g. SQL2API_RATE_LIMIT
+        print(f'sql2api: {error}', file=sys.stderr)
+        return 2
     if args.host not in LOOPBACK_HOSTS and not config.api_key():
         logging.getLogger('sql2api').warning(
             'Listening on %s without SQL2API_API_KEY set: anyone who can reach this port can run SQL '

sql2api/config.py

@@ -1,11 +1,15 @@
 """Runtime configuration, read from environment variables at call time."""
 import os
+import re
 from pathlib import Path
 
 SUPPORTED_DB_TYPES = ('mysql', 'postgres', 'clickhouse', 'sqlite', 'h2')
 PASSWORD_MASK = '********'
 CONNECT_TIMEOUT = 10  # seconds
 HISTORY_LIMIT = 50  # executions remembered per saved-query version
+DEFAULT_QUERY_TIMEOUT = 30.0  # seconds
+DEFAULT_POOL_SIZE = 5  # idle connections kept per distinct connection
+DEFAULT_POOL_IDLE_TIMEOUT = 300.0  # seconds
 
 # Ships with the package; override with SQL2API_H2_JAR to use a different H2 version.
 BUNDLED_H2_JAR = Path(__file__).parent / 'lib' / 'h2-2.2.224.jar'
@@ -55,6 +59,96 @@ def api_key():
     return os.environ.get('SQL2API_API_KEY') or None
 
 
+def query_timeout():
+    """Server-wide statement time limit in seconds (SQL2API_QUERY_TIMEOUT); None when disabled (set to 0)."""
+    try:
+        value = float(os.environ.get('SQL2API_QUERY_TIMEOUT', DEFAULT_QUERY_TIMEOUT))
+    except ValueError:
+        return DEFAULT_QUERY_TIMEOUT
+    if value == 0:
+        return None
+    return value if value > 0 else DEFAULT_QUERY_TIMEOUT
+
+
+def effective_timeout(requested=None):
+    """The limit to enforce: a request may ask for less time than the server allows, never more."""
+    limit = query_timeout()
+    if requested is None:
+        return limit
+    return requested if limit is None else min(requested, limit)
+
+
+def pool_size():
+    """Idle connections kept per distinct connection (SQL2API_POOL_SIZE); 0 disables pooling."""
+    try:
+        return max(0, int(os.environ.get('SQL2API_POOL_SIZE', DEFAULT_POOL_SIZE)))
+    except ValueError:
+        return DEFAULT_POOL_SIZE
+
+
+def pool_idle_timeout():
+    """Seconds an idle pooled connection is kept before it is closed (SQL2API_POOL_IDLE_TIMEOUT)."""
+    try:
+        value = float(os.environ.get('SQL2API_POOL_IDLE_TIMEOUT', DEFAULT_POOL_IDLE_TIMEOUT))
+    except ValueError:
+        return DEFAULT_POOL_IDLE_TIMEOUT
+    return value if value > 0 else DEFAULT_POOL_IDLE_TIMEOUT
+
+
+def cors_origins():
+    """Origins allowed to call the API from a browser (SQL2API_CORS_ORIGINS): None (off), '*' or a frozenset.
+
+    Entries are compared case-insensitively and without a trailing slash, e.g. https://app.example.com.
+    """
+    raw = os.environ.get('SQL2API_CORS_ORIGINS', '').strip()
+    if not raw:
+        return None
+    origins = [item.strip().rstrip('/').lower() for item in raw.split(',') if item.strip()]
+    if '*' in origins:
+        return '*'
+    return frozenset(origins) or None
+
+
+_RATE_PERIODS = {'second': 1, 'minute': 60, 'hour': 3600, 'day': 86400}
+_RATE_RE = re.compile(r'^\s*(\d+)\s*/\s*(second|minute|hour|day)s?\s*$', re.I)
+
+
+def parse_rate_limit(text):
+    """Parse '60/minute' (also second, hour, day) into (requests, seconds); raises ValueError when malformed."""
+    match = _RATE_RE.match(text or '')
+    if not match or int(match.group(1)) < 1:
+        raise ValueError(f"SQL2API_RATE_LIMIT must look like '60/minute' (a positive count, then second, minute, "
+                         f"hour or day), not {text!r}")
+    return int(match.group(1)), _RATE_PERIODS[match.group(2).lower()]
+
+
+def rate_limit():
+    """(requests, seconds) allowed per client (SQL2API_RATE_LIMIT), or None when limiting is off."""
+    raw = os.environ.get('SQL2API_RATE_LIMIT', '').strip()
+    if not raw:
+        return None
+    try:
+        return parse_rate_limit(raw)
+    except ValueError:
+        return None  # create_app() rejects a malformed value at startup; never limit by accident afterwards
+
+
+def proxy_hops():
+    """Reverse proxies in front of the app whose X-Forwarded-* headers can be trusted (SQL2API_TRUST_PROXY)."""
+    try:
+        return max(0, int(os.environ.get('SQL2API_TRUST_PROXY', 0)))
+    except ValueError:
+        return 0
+
+
+def check_settings():
+    """Raise ValueError for a malformed setting, so a typo fails at startup instead of silently switching off a
+    protection."""
+    raw = os.environ.get('SQL2API_RATE_LIMIT', '').strip()
+    if raw:
+        parse_rate_limit(raw)
+
+
 def max_page_size():
     try:
         return max(1, int(os.environ.get('SQL2API_MAX_PAGE_SIZE', 1000)))

sql2api/cors.py

@@ -0,0 +1,51 @@
+"""Cross-origin (CORS) support for browser clients, off unless SQL2API_CORS_ORIGINS is set.
+
+Without it a web page on another origin cannot call the API: browsers refuse to send the JSON requests and to read
+the answers. CORS only tells the *browser* which sites may call; it is not authentication (use SQL2API_API_KEY).
+"""
+from flask import Response
+
+from . import config
+
+ALLOWED_METHODS = 'GET, POST, PATCH, DELETE, OPTIONS'
+ALLOWED_HEADERS = 'Content-Type, X-API-Key'
+# Browsers hide response headers a page has not been told about, and pagination depends on these.
+EXPOSED_HEADERS = 'X-Page, X-Page-Size, X-Has-More, X-RateLimit-Limit, X-RateLimit-Remaining, Retry-After'
+PREFLIGHT_MAX_AGE = '600'
+
+
+def allow_origin_value(origin):
+    """The Access-Control-Allow-Origin value for a request from ``origin``, or None when it is not allowed."""
+    allowed = config.cors_origins()
+    if allowed is None or not origin:
+        return None
+    if allowed == '*':
+        return '*'
+    return origin if origin.rstrip('/').lower() in allowed else None
+
+
+def is_preflight(request):
+    return (request.method == 'OPTIONS' and 'Access-Control-Request-Method' in request.headers
+            and config.cors_origins() is not None)
+
+
+def preflight_response(origin):
+    """Answer a browser's permission check before it sends the real request (no auth: it carries no key)."""
+    response = Response(status=204)
+    value = allow_origin_value(origin)
+    if value:
+        response.headers['Access-Control-Allow-Methods'] = ALLOWED_METHODS
+        response.headers['Access-Control-Allow-Headers'] = ALLOWED_HEADERS
+        response.headers['Access-Control-Max-Age'] = PREFLIGHT_MAX_AGE
+        add_headers(response, origin)
+    return response
+
+
+def add_headers(response, origin):
+    value = allow_origin_value(origin)
+    if value:
+        response.headers['Access-Control-Allow-Origin'] = value
+        response.headers['Access-Control-Expose-Headers'] = EXPOSED_HEADERS
+        if value != '*':
+            response.headers.add('Vary', 'Origin')  # the answer depends on who asked
+    return response

sql2api/engine.py

@@ -5,19 +5,22 @@ import time
 from . import config, store
 from .errors import ApiError
 from .formats import ResultSetDTO
+from .pool import get_pool
 from .runners import RUNNERS
 from .sqltools import validate_sql
 
 log = logging.getLogger('sql2api')
 
 
-def execute_sql(sql, connection_name, limit, offset, params=None):
+def execute_sql(sql, connection_name, limit, offset, params=None, timeout=None):
     """Run ``sql`` on a named connection and return the requested page as a ResultSetDTO."""
     details = store.get_connection(connection_name)
     sql = validate_sql(sql)
-    log.info('Executing on %s (%s), limit=%s offset=%s: %s', connection_name, details['db'], limit, offset, sql)
+    log.info('Executing on %s (%s), limit=%s offset=%s timeout=%s: %s',
+             connection_name, details['db'], limit, offset, timeout, sql)
     try:
-        columns, rows = RUNNERS[details['db']](details, sql, params, limit, offset, not config.allow_writes())
+        columns, rows = RUNNERS[details['db']](details, sql, params, limit, offset, not config.allow_writes(), timeout,
+                                             get_pool())
     except ApiError:
         raise
     except ImportError as error:

sql2api/openapi.py

@@ -1,5 +1,9 @@
 """OpenAPI description of the API, served at /openapi.json and rendered at /docs."""
+import re
+from urllib.parse import quote
+
 from . import config
+from .params import json_schema
 
 _FORMAT_PARAM = {'name': 'format', 'in': 'query', 'schema': {
     'type': 'string', 'enum': ['json', 'ndjson', 'csv', 'tsv', 'xml', 'yaml', 'xlsx'], 'default': 'json'}}
@@ -7,17 +11,27 @@ _PAGE_PARAMS = [
     {'name': 'page', 'in': 'query', 'schema': {'type': 'integer', 'minimum': 1, 'default': 1}},
     {'name': 'page_size', 'in': 'query', 'schema': {'type': 'integer', 'minimum': 1, 'default': 10},
      'description': 'Upper limit is SQL2API_MAX_PAGE_SIZE (default 1000).'},
+    {'name': 'timeout', 'in': 'query', 'schema': {'type': 'number', 'minimum': 0, 'exclusiveMinimum': True},
+     'description': 'Seconds the query may run before it is cancelled (504). Can lower, never raise, the server '
+                    'limit SQL2API_QUERY_TIMEOUT (default 30; 0 disables the server limit).'},
 ]
 _ROWS = {'description': 'The requested page. Header X-Has-More says whether another page follows.',
          'headers': {'X-Page': {'schema': {'type': 'integer'}}, 'X-Page-Size': {'schema': {'type': 'integer'}},
                      'X-Has-More': {'schema': {'type': 'string', 'enum': ['true', 'false']}}},
          'content': {'application/json': {'schema': {'type': 'array', 'items': {'type': 'object'}}}}}
-_ERRORS = {c: {'$ref': '#/components/responses/Error'} for c in ('400', '401', '403', '404', '500')}
+_ERRORS = {c: {'$ref': '#/components/responses/Error'} for c in ('400', '401', '403', '404', '429', '500', '504')}
+
+
+def _object_schema(properties, required=()):
+    """An object schema; OpenAPI 3.0 forbids an empty ``required`` list, so it is only included when non-empty."""
+    schema = {'type': 'object', 'properties': properties}
+    if required:
+        schema['required'] = list(required)
+    return schema
 
 
 def _body(properties, required):
-    return {'required': True, 'content': {'application/json': {'schema': {
-        'type': 'object', 'required': required, 'properties': properties}}}}
+    return {'required': True, 'content': {'application/json': {'schema': _object_schema(properties, required)}}}
 
 
 _EXEC_PROPS = {
@@ -29,10 +43,58 @@ _EXEC_PROPS = {
 }
 
 
-def build_spec(version):
+def _saved_query_paths(queries):
+    """One documented endpoint per saved query, with its declared parameters and rules."""
+    paths, seen = {}, set()
+    for query in queries:
+        name = query['name']
+        has_default_connection = bool(query.get('connection_name'))
+        properties, required, query_params = {}, [], []
+        for param, spec in query['parameters'].items():
+            schema = json_schema(spec)
+            entry = {'name': param, 'in': 'query', 'required': spec['required'], 'schema': schema}
+            if spec['description']:
+                entry['description'] = spec['description']
+            query_params.append(entry)
+            properties[param] = {**schema, **({'description': spec['description']} if spec['description'] else {})}
+            if spec['required']:
+                required.append(param)
+        connection = {'name': 'connection_name', 'in': 'query', 'required': not has_default_connection,
+                      'schema': {'type': 'string', **({'default': query['connection_name']}
+                                                      if has_default_connection else {})}}
+        common = [connection, {'name': 'version', 'in': 'query', 'schema': {'type': 'integer'},
+                               'description': f"Saved version to run (default: latest, currently {query['version']})."},
+                  _FORMAT_PARAM, *_PAGE_PARAMS]
+        summary = query.get('description') or f'Run the saved query {name}'
+        tags = query.get('tags')
+        detail = f"Runs version {query['version']} of the saved query '{name}'."
+        if tags:
+            detail += ' Tags: ' + (tags if isinstance(tags, str) else ', '.join(map(str, tags))) + '.'
+        operation_id = 'run_' + re.sub(r'\W', '_', name)
+        while operation_id in seen:
+            operation_id += '_'
+        seen.add(operation_id)
+        body_properties = {'params': _object_schema(properties, required),
+                           'connection_name': connection['schema'], 'version': {'type': 'integer'},
+                           'format': {'type': 'string'}, 'timeout': {'type': 'number'}}
+        paths['/q/' + quote(name, safe='')] = {
+            'get': {'summary': summary, 'description': detail, 'tags': ['Saved queries (live)'],
+                    'operationId': operation_id, 'parameters': [*query_params, *common],
+                    'responses': {'200': _ROWS, **_ERRORS}},
+            'post': {'summary': summary + ' (parameters in a JSON body)', 'description': detail,
+                     'tags': ['Saved queries (live)'], 'operationId': operation_id + '_post',
+                     'parameters': [_FORMAT_PARAM, *_PAGE_PARAMS],
+                     'requestBody': {'required': bool(required), 'content': {'application/json': {
+                         'schema': _object_schema(body_properties)}}},
+                     'responses': {'200': _ROWS, **_ERRORS}},
+        }
+    return paths
+
+
+def build_spec(version, saved_queries=None):
     saved = {'filepath': {'type': 'string', 'description': 'Saved query name or path inside saved_sql/.'},
              **_EXEC_PROPS}
-    return {
+    spec = {
         'openapi': '3.0.3',
         'info': {'title': 'SQL2API', 'version': version,
                  'description': 'Run SQL against configured databases and get the results back over HTTP.'},
@@ -116,12 +178,42 @@ def build_spec(version):
                                 'responses': {'200': {'description': 'OK'}}}},
         },
     }
+    if saved_queries:
+        spec['paths'].update(_saved_query_paths(saved_queries))
+        spec['tags'] = [{'name': 'Saved queries (live)',
+                         'description': 'One endpoint per saved query, generated from its latest version: its '
+                                        'declared parameters and their rules, and its default connection.'}]
+    return spec
 
 
 DOCS_HTML = """<!doctype html>
 <html><head><meta charset="utf-8"><title>SQL2API docs</title>
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css"></head>
-<body><div id="ui"></div>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
+<style>
+  body { margin: 0; font-family: sans-serif; }
+  #key-bar { padding: 8px 16px; background: #f4f4f4; border-bottom: 1px solid #ddd; font-size: 14px; }
+  #key-bar input { width: 260px; padding: 4px; }
+</style></head>
+<body>
+<div id="key-bar">
+  API key (only needed if the server sets SQL2API_API_KEY; it reveals your saved queries below and is
+  sent with "Try it out" requests; kept for this browser tab only):
+  <input id="key" type="password" autocomplete="off" placeholder="X-API-Key">
+  <button id="save-key">Apply</button>
+</div>
+<div id="ui"></div>
 <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
-<script>SwaggerUIBundle({url: 'openapi.json', dom_id: '#ui'});</script></body></html>
+<script>
+  var stored = '';
+  try { stored = sessionStorage.getItem('sql2api-key') || ''; } catch (e) {}
+  document.getElementById('key').value = stored;
+  document.getElementById('save-key').onclick = function () {
+    try { sessionStorage.setItem('sql2api-key', document.getElementById('key').value); } catch (e) {}
+    location.reload();
+  };
+  SwaggerUIBundle({
+    url: 'openapi.json', dom_id: '#ui',
+    requestInterceptor: function (req) { if (stored) { req.headers['X-API-Key'] = stored; } return req; }
+  });
+</script></body></html>
 """