REST API Connector

Use RestAPIReader to ingest JSON-centric REST endpoints, including query-based and response-driven pagination, retry handling, and Spark-native schema inference.

Bases: Connector

Connector that loads JSON payloads from REST APIs into Spark DataFrames.

write

write(df: DataFrame, path: str, *, fmt: Optional[str] = None, mode: str = 'error', **options: Any) -> None

Writing back to REST APIs is not supported.

Source code in src/spark_fuse/io/rest_api.py

def write(
    self,
    df: DataFrame,
    path: str,
    *,
    fmt: Optional[str] = None,
    mode: str = "error",
    **options: Any,
) -> None:
    """Writing back to REST APIs is not supported."""
    raise NotImplementedError("RestAPIReader does not support write operations")