kittinunf/fuel
Fuel
Fuel is a Kotlin HTTP client library for Android and Kotlin applications that handles both synchronous and asynchronous web requests. It functions as a network wrapper that supports executing calls via suspending functions in coroutines, reactive streams, and traditional callbacks.
The library features built-in integration for Android LiveData to bind network responses directly to observable state holders for user interface updates. It also includes a JSON serialization client that utilizes customizable mappers to convert raw HTTP response bodies into structured data objects.
Capability areas cover REST API integration, including request routing, header and parameter configuration, and basic authentication. The toolset extends to binary data transfer through multipart uploads and file downloading with progress tracking. For maintenance and observability, it provides an interceptor-based pipeline for traffic logging and a mechanism to simulate network calls as blocking executions for unit testing.
Features
- HTTP Client Libraries - A comprehensive Kotlin and Android HTTP client library for synchronous and asynchronous web requests.
- HTTP Request Execution - Provides comprehensive capabilities for performing standard synchronous and asynchronous HTTP operations like GET and POST.
- Asynchronous Data Fetching - Executes network calls using coroutines and reactive streams to prevent blocking the main thread.
- Android HTTP Networking Libraries - Serves as a networking library for Android applications to execute HTTP requests and handle server responses.
- Network Wrappers - Functions as a networking wrapper with built-in support for Android LiveData and UI thread callbacks.
- REST API Integration Frameworks - Provides a framework for connecting to RESTful services by mapping method signatures to API endpoints.
- Coroutine-Compatible Clients - Uses suspending functions to execute network calls without blocking the main execution thread.
- Reactive HTTP Wrappers - Wraps network responses in reactive streams to enable functional composition for asynchronous data handling.
- Coroutine-Based Asynchronous I/O - Uses coroutines and suspending functions to manage network I/O without blocking the main execution thread.
- Kotlin Coroutines Integration - Provides native support for executing network requests within Kotlin suspending functions to ensure non-blocking UI operations.
- Response Deserialization - Converts raw HTTP response bodies into structured, typed data objects using configurable serialization mappers.
- Android LiveData State Bindings - Connects network response data to observable LiveData holders that trigger automatic user interface updates.
- LiveData Bindings - Binds network response data directly to Android LiveData holders to trigger automatic user interface updates.
- JSON Request Serializers - Implements automated serialization of request data into JSON format for outgoing payloads.
- Response Body Streaming - Handles large payloads by piping response bodies directly to local files or output streams to minimize memory usage.
- JSON Response Parsers - Provides utilities to convert JSON-formatted server responses into structured data objects.
- Client-Side Request Routing - Implements a structured router pattern to organize web service calls, endpoints, and common configurations.
- Global HTTP Client Configurations - Manages shared base paths, common HTTP headers, and custom client drivers across all requests via a central manager.
- JSON Serialization - Provides utilities for converting data objects to JSON for network transmission and parsing responses.
- Multipart Form Uploads - Supports transmitting files and binary data to servers using the standard HTTP multipart/form-data encoding.
- Response Body Deserializers - Converts raw network response bodies into structured data objects using mapping extensions.
- Progress-Tracking File Downloads - Streams remote response bodies directly to local storage with real-time download progress tracking.
- Request Header Configuration - Offers tools for defining and managing custom HTTP request headers for metadata and authentication.
- Request Interceptors - Provides an interceptor-based pipeline to process requests and responses for logging or data persistence.
- Bidirectional Progress Tracking - Monitors byte transfer during both uploads and downloads using registered listeners to track real-time progress.
- Worker-to-UI Thread Messaging - Posts network request responses from background threads to the UI thread for immediate interface updates.
- Reactive Stream Bindings - Wraps network responses in reactive observables to allow asynchronous data and error handling through a streaming model.
- API Patterns - Implements structural templates and organizational strategies for routing service communication endpoints.
- HTTP Endpoint Mapping - Associates structured objects with specific HTTP methods and URI paths to organize API routing logic.
- Mobile File Transfer Clients - Supports uploading local files via multipart form-data and downloading remote content to device storage.
- Request Body Attachers - Allows attaching raw strings, byte arrays, or streams as the body of an outgoing HTTP request.
- Request Parameter Formatting - Automatically formats key-value pairs into query strings or form-encoded bodies for outgoing requests.
- Request-Response Interceptors - Processes outgoing requests and incoming responses through a custom interceptor chain for logging and authentication.
