square/retrofit
Retrofit
Retrofit is a type-safe HTTP client that simplifies network communication by allowing developers to define API endpoints as interface methods. By using annotation-driven request mapping, it automatically translates these interface definitions into structured HTTP requests, ensuring consistent data structures and reducing manual configuration when interacting with remote web services.
The project distinguishes itself through a highly modular architecture that separates network transport from data handling. It utilizes dynamic proxy generation to process method calls at runtime and offers a pluggable converter system that automates the serialization and deserialization of request and response bodies. Furthermore, its call adapter pattern enables the transformation of network execution results into various asynchronous types or observable streams, providing flexibility in how applications manage background operations and data flows.
Beyond its core request handling, the library supports a wide range of network operations, including URL, header, and request body manipulation, as well as form-encoded and multipart data. It provides built-in support for mocking server responses to facilitate testing and includes extensive integration options for various data formats and reactive programming libraries. The documentation provides comprehensive guidance on configuring these adapters and converters to suit specific project requirements.
Features
- Declarative API Clients - Defines HTTP endpoints using annotations for clean networking code.
- HTTP Clients - Provides a declarative interface for defining network requests that automatically maps remote service endpoints to local language methods and data structures.
- Request Mappings - Maps method parameters and interface definitions to HTTP components like headers, paths, and query parameters using metadata.
- Call Adapters - Enables the transformation of network execution results into various asynchronous types or observable streams via modular adapters.
- Data Converters - Decouples data serialization from network transport by allowing interchangeable modules to transform request and response bodies.
- Data Serialization - Automates the conversion of network responses into native objects.
- Dynamic Proxies - Uses dynamic proxies to transform annotated interface method calls into structured HTTP request objects at runtime.
- Android Libraries - Type-safe HTTP client for API interaction.
- Networking Libraries - Provides a type-safe REST client for Android and Java.
- Reactive Libraries - Integrates reactive streams into network communication layers.
- More to explore - Type-safe HTTP client for Android and JVM.
- Execution Strategies - Supports both blocking and non-blocking network operations by delegating request dispatching to a configurable underlying HTTP client.
- Reactive Networking - Adapts network requests into observable streams for complex data flows.
- Kotlin Extensions - Provides first-class support for Kotlin language features and idioms.
- API Mocking - Provides support for mocking network requests in tests.
- Asynchronous Patterns - Provides support for both synchronous and asynchronous network request patterns.
- Request Adapters - Allows transforming default network request interfaces into custom types to simplify data handling.
- Serialization Converters - Enables the definition of custom rules to serialize and deserialize request and response bodies.
- Header Management - Allows for the dynamic manipulation of HTTP request headers.
- HTTP Methods - Enables the specification of HTTP request methods through annotations.
- Network Request Adapters - Adapts network calls into custom asynchronous execution patterns.
- Request Body Handling - Supports flexible definition and serialization of request bodies.
- URL Construction - Allows for dynamic construction and manipulation of request URLs.
