Retrofit: Love Working with APIs on Android
Retrofit: Love Working with APIs on Android
Take delight in building API clients on Android.
About the Book
Painless Networking with Retrofit
The content of this book is completely updated to Retrofit 2.5!
Every modern Android app needs to connect to at least one private or public API. Interacting with services can be difficult due to the extreme variety of request and response formats. Depending on the API, you’ll need to change your request payloads, authentication, data formats, and much more.
Retrofit: a type-safe HTTP client for Android and Java
Retrofit handles all of the complicated and repetitive parts of network implementations for you. It hides the entire network layer, from creating a connection to processing the handling on a separate thread, from you. Retrofit even does the mapping of the requests and responses to Java objects for you (e.g., creating a JSON payload from your passed
List<User>). You only need to describe what and how you want to send or receive it.
This awesomeness comes at a cost: an initial learning curve. Retrofit might look a little more complicated at the beginning, but pays off multiple times in the long run.
If you’re thinking about using Retrofit, or haven’t developed a deep knowledge of it yet, you’ll benefit from this book. We’ve created this book with the vision of being the ultimate guide to understanding Retrofit. After working through this book, you’ll be able to connect to new APIs and services within minutes.
You can find a Retrofit tutorial series on our website and our free video tutorial series on YouTube, where we describe some elements of Retrofit. The book extends and connects these tutorials into one common thread that guides you through all important aspects of Retrofit. The chapters are structured in a way that rewards a linear reading. Retrofit rookies can and should read it cover to cover. Experienced Retrofit developers can jump to specific sections for guides on how to solve their specific problem.
What Topics Are Covered in This Book?
The list below provides a comprehensive overview of covered topics in the book.
- Introduction to Retrofit
- Quick Start Guide to jump right into Retrofit
- Creating a sustainable Android REST client
- Extensive manipulation and customization of requests (e.g., query and path parameters, form-urlencoding, synchronous vs. asynchronous)
- Cancel, analyze and re-use requests
- Comprehensive overview of response converters and data mapping with plenty practical examples of applied (custom) converters
- Implementing and handling authentication (basic, token, OAuth, hawk) in a smart way
- File uploads, including multiple and dynamic amounts of files (optionally with progress updates)
- File download (optionally with progress updates)
- Detailed chapter on implementing pagination
- Introduction and example of possible ways to deal with errors in a clean way
- Debug requests and responses using three logging tools (OkHttp, Stetho, Android Studio Profiler)
- Fundamentals for mocking server responses
- Entire chapter on practical examples of custom converters dealing with specific scenarios
- Detailed introduction to call adapters, including custom implementations
- Extensive chapter on implementing response caching with Retrofit
- Example for an offline mode based on cached server responses
- A chapter with practical tips & tricks (including crawling websites with Retrofit)
- App release preparation including ProGuard configuration
Additionally to the regular content we provide an appendix with three sections:
- Upgrade guide from Retrofit 1.9 to 2.0
- Java basics for Retrofit
- Network basics for developers, who just started interacting with APIs
Who Is This Book For?
In short: this book is for you. We believe that every developer reading this book will take away new ideas on how to optimize their Android apps in the sense of interacting with APIs or web services using Retrofit. You’ll recognize goodies that are applicable for the projects you’re working on.
This book is for Android developers, who want to receive a substantial overview and reference book on Retrofit. You’ll benefit from clearly recognizable code examples related to your daily work with Retrofit.
If you’re just starting out with Retrofit (or coming from another HTTP library like Android Asynchronous Http Client or Volley) this book will show you all important parts on how to create sustainable REST clients on Android. The provided code snippets let you jumpstart and create your first successful API client within minutes!
If you’ve already worked with Retrofit, you’ll profit from our extensive code snippets and apply the learnings to your existing code base. Additionally, the book illustrates various use cases for different functionalities and setups like authentication against different backends, request composition, file uploads and downloads, and much more!
One focus of this book is not only to implement the requirements, but also do so in a clean way. We’ve seen way to many complicated and messy usages of Retrofit. We focus on providing code samples which adhere to clean code standards. We avoid any unnecessary duplication at all costs. This has the side effect of some extra app performance gains by efficient Java object handling.
Source Code Samples
With the purchase of this book, you benefit from the sample project that awaits your download within the extras section on Leanpub. The sample project is an Android project based on gradle. You can directly touch and use classes that are only illustrated in excerpts within this book.
Check your Leanpub Library and select Retrofit: Love working with APIs on Android to download the sample code base.
We’ve published the first version of this Retrofit book in July 2015. Since this initial release we’ve extended and updated the book more than a dozen times. Once you buy the book, you get all future updates for free. Even if it’s a huge Retrofit update, for example from version 1.9 to 2.0. With every new release of Retrofit we’ll evaluate the entire book content and update it accordingly.
Of course, we’re listening to your feedback and add new sections and even chapters, if it can be useful to all readers. If you still have a question after reading this book, let us know and we might be able to help!
If you’re still on the fence if this book helps you, checkout the sample or, even better, use Leanpub’s (and our) happiness guarantee. Try this book out and if you don’t think this book provides enough value, you can refund your money within 45 days with no questions asked. You don’t have any risk in testing this book, which saves you hours of headaches and makes your Android app code so much cleaner.
Final Note: Retrofit Book for Version 1.9
The current version of this book is fully focused on Retrofit 2.x, no hint or code snippet that points to Retrofit 1. If you’re interested in the first version of the book that based on Retrofit 1, please visit this book’s extras page on Leanpub. As a reader of this book, the first version is also available for you!
Norman is passionate Android developer since 2011. He's developed multiple apps, which have been used by millions of users overall. Building high-quality products is always Norman's #1 focus. While working as an Android freelancer and consultant is his day job, he loves teaching and passing on knowledge on the side.
Since 2014, Norman started working on the API side as well. Developing node.js apps is a good alternative and provides some good insight into becoming a better programmer overall.
Norman has a Master's degree from the Otto von Guericke University Magdeburg.
- What Topics Are Waiting for You?
- Who Is This Book For?
- The Source Code
- Retrofit Book for Version 1.9
Chapter 1 — Quick Start & Create a Sustainable REST Client
- Retrofit Overview
- Why Use Retrofit?
- Retrofit vs. OkHttp
- Quick Start: Add Retrofit to Your Project
- Sustainable Android REST Client
- Retrofit in Use
Chapter 2 — Requests
- Retrofit API Declaration
- Url Handling, Resolution and Parsing
- Query Parameter
- Path Parameter
- Synchronous and Asynchronous Requests
- Send Objects in Request Body
- Constant, Default and Logic Values for POST and PUT Requests
- Send Data Form-Urlencoded
- Add Request Header
- Reuse, Analyze & Cancel Requests
- Customize Network Timeouts
- Ignore Response Payload with Call<Void>
Chapter 3 — Data Mapping with Retrofit Converters
- Integrate a JSON Converter
- Integrate an XML Converter
- Integrate Other Standard Formats
- Deal with Multiple Converters
- Integrate Your Own Custom Converter
- Access Mapped Objects and Raw Response Payload
- Further Custom Converter Examples
Chapter 4 — Authentication
- Authentication Interceptor
- Basic Authentication
- Token Authentication
- OAuth 2
- OAuth — Refresh Your Access Token
- Hawk Authentication
- Dynamic Endpoint-Dependent Interceptor Actions
Chapter 5 — File Upload & Download
- File Upload
- Upload of Multiple Files
- Upload of Dynamic Amount of Files
- Uploading Files with Progress Updates
- Passing Multiple Parts Along a File with @PartMap
- File Download
- File Download with Progress Updates
Chapter 6 — Pagination on Android
- Pagination Response Status
- Pagination Using Query Parameter
- Pagination Using Link Header and Dynamic Urls (Like GitHub)
- Pagination Using Range Header Fields (Like Heroku)
Chapter 7 — Error Handling
- Error Handling Preparations
- Simple Error Handler
- Error Handling for Synchronous Requests
- How to Detect Network and Conversion Errors in onFailure
- Catch Server Errors Globally with Response Interceptor
Chapter 8 — Logging
- Log Requests and Responses with Retrofit
- Enable Logging for Debug Builds Only
- Log Network Traffic with Stetho and Chrome Developer Tools
- Analyze Network Traffic with Android Studio Profiler
Chapter 9 — Multiple Server Environments
- Product-Flavor-Dependent Base URLs
- Change API Base URL at Runtime
Chapter 10 — Caching
- Activate Response Caching (Etag, Last-Modified)
- Check Response Origin (Network, Cache, or Both)
- Analyze Cache Files
- Force Server Cache Support with Response Interceptor
- Support App Offline Mode by Accessing Response Caches
Chapter 11 — Client-Side Mocking of Server Responses
- Why Mocking Responses Make Sense
- Create Your Own MockRetrofit Implementation
- Customizing Network Behavior of Mocked Server Responses
Chapter 12 — Practical Converters
- Handling of Empty Server Responses
- Supporting JSON and XML Responses Concurrently
- Send JSON Requests and Receive XML Responses (or vice versa)
- Unwrapping Envelope Responses
- Wrapping Requests in Envelope
Chapter 13 — Call Adapters
- Call Adapter Basics — What Are They?
- Integration of Retrofit Callbacks into Your RxJava 1 Flow
- Integration of Retrofit Callbacks into Your RxJava 2 Flow
- Integration of Retrofit Callbacks into Your Guava Flow
onResponseCallback with Custom Call Adapter
onFailureCallback with Custom Call Adapter
Chapter 14 — Practical Usages
- Share OkHttp Client and Converters between Retrofit Instances
- How to Trust Unsafe SSL certificates (Self-signed, Expired)
- Receive Plain-String Responses
- Crawl HTML Responses with jspoon (Wikipedia Example)
Chapter 15 — App Release Preparation
- Enable ProGuard
- Configure ProGuard Rules for Retrofit
- Obfuscated Stack Traces
Appendix A — Retrofit 2 Upgrade Guide from 1.x
- Maven & Gradle Dependencies
- RestAdapter —> Retrofit
- setEndpoint —> baseUrl
- Base Url Handling
- Dynamic Urls
- OkHttp Required
- Interceptors Powered by OkHttp
- Synchronous & Asynchronous Requests
- Cancel Requests
- No Default Converter
- RxJava Integration
- No Logging
- Future Update: WebSockets in Retrofit 2.2
Appendix B — Java Basics for Retrofit
- Java Annotations
- Java Callbacks
- Fluent Interface with Builders
Appendix C — Network Basics for Retrofit
- HTTP Basics
- Client Requests
- Request Methods
- Server Responses
- Status Codes
- Future Protocols
Future Studio Books
- Future Studio Bundle
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Ansible for KubernetesJeff Geerling
Ansible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
Practical FP in Scala: A hands-on approachGabriel Volpe
A practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Production HaskellMatt Parsons
Are you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
Tame your Work FlowSteve Tendon and Daniel Doiron
Do you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
Ansible for DevOpsJeff Geerling
Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Machine Learning EngineeringAndriy Burkov
"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Composing SoftwareEric Elliott
All software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
El Manual del ManagerKeyvan Akbary, Félix López, and Álvaro Salazar
¿Has deseado alguna vez el haber tenido una buena introducción al rol del Engineering Manager? En este libro aprenderás lo necesario para ejercer el rol de una manera efectiva: Expectativas y Responsabilidades del Rol, 1-1s, Ayudar a Crecer, Objetivos, Planes de Carrera, Cultura, Feedback, Contratación, Cultura de Producto y mucho más.
The Tester's Library
8 BooksThe Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other...
11 BooksIn this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people.
WTFlop 6M + HU - Beta Bundle
Marionette.js A to Z
Build A Better Backbone App
3 BooksThe best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
General Systems Thinker Bundle
5 BooksThe General Systems Thinker Bundle is just that: a bundle of five books to advance the reader one giant step toward improved thinking, based on General Systems principles. Four of the books are the complete General Systems Series. The fifth is fictional piece which shows some general systems thinkers in action. It's a mystery in which a group of...
Experiential Learning Bundle
4 BooksThis bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately.
2 BooksAfter getting up and running with Ansible in Jeff Geerling's Ansible for DevOps, strengthen your skills managing tens to thousands of instances and services in Amazon's AWS cloud with Yan Kurniawan's Ansible for AWS.
Learn ECMAScript 6 inside and out
2 BooksFor any technology, it helps to get multiple points of view on the functionality to get the best possible understanding. For ECMAScript 6/2015, no two resources are recommended more frequently thanExploring ES6by Dr. Axel Rauschmayer andUnderstanding ECMAScript 6by Nicholas C. Zakas. These two points of view, investigating the specification and...
Software architecture, for systems old and new
2 BooksThis bundle includes books about hands-on software architecture.