Docs
Launch GraphOS Studio
You're viewing documentation for a previous version of this software. Switch to the latest stable version.

Introduction to Apollo Android

A strongly-typed, caching GraphQL client for the JVM, Android and Kotlin multiplatform


Apollo Android is a that generates Java and Kotlin models from GraphQL queries. These models give you a type-safe API to work with . Apollo helps you keep your GraphQL statements together, organized, and easy to access.

This library is designed primarily with Android in mind, but you can use it in any Java/Kotlin app.

Features

  • Java and Kotlin code generation
  • Queries, and s
  • Reflection-free parsing of responses
  • HTTP cache
  • Normalized cache
  • File uploads
  • Custom types
  • Reactive bindings for: RxJava2, RxJava3, Coroutines, Reactor and Mutiny

Getting started

If you are new to , check out

that will guide you through building an Android app using Apollo, Kotlin and coroutines.

If you'd like to add Apollo Android to an existing project:

Advanced topics

Check

for in depth documentation about
caching
,
plugin configuration
,
android
,
file upload
,
coroutines
,
rxjava2
,
rxjava3
,
reactor
,
mutiny
,
persisted queries
,
no runtime
,
migrations
and much more...

IntelliJ Plugin

The

provides auto-completion, error highlighting, and go-to-definition functionality for your .graphql files. You can create a
.graphqlconfig
file to use scratch files to work with your schema outside product code (such as to write temporary queries to test ).

Releases

The latest version is

Maven Central

Check the

for the release history.

Releases are hosted on

and
Maven Central
. The plugin is additionally hosted on the
Gradle Plugin Portal

build.gradle.kts
plugins {
id("com.apollographql.apollo").version("x.y.z")
}
repositories {
mavenCentral()
}
dependencies {
implementation("com.apollographql.apollo:apollo-runtime:x.y.z")
// optional: if you want to use the normalized cache
implementation("com.apollographql.apollo:apollo-normalized-cache-sqlite:x.y.z")
// optional: for coroutines support
implementation("com.apollographql.apollo:apollo-coroutines-support:x.y.z")
// optional: for Mutiny support
implementation("com.apollographql.apollo:apollo-mutiny-support:x.y.z")
// optional: for Reactor support
implementation("com.apollographql.apollo:apollo-reactor-support:x.y.z")
// optional: for RxJava3 support
implementation("com.apollographql.apollo:apollo-rx3-support:x.y.z")
// optional: Most of apollo-android does not depend on Android in practice and runs on any JVM or on Kotlin native. apollo-android-support contains a few Android-only helper classes. For an example to send logs to logcat or run callbacks on the main thread.
implementation("com.apollographql.apollo:apollo-android-support:x.y.z")
// optional: if you just want the generated models and parsers and write your own HTTP code/cache code, you can remove apollo-runtime
// and use apollo-api instead
implementation("com.apollographql.apollo:apollo-api:x.y.z")
}

Snapshots

Latest development changes are available in Sonatype's snapshots repository:

build.gradle.kts
repositories {
maven {
url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
}

Requirements

Apollo Android runs on the following platforms:

  • Android API level 15+
  • JDK 8+
  • iOS 13+

Contributing

If you'd like to contribute, please see

.

Community integrations

Additional resources

Who is Apollo?

builds open-source software and a platform to unify across your apps and services. We help you ship faster with:

  • Apollo Studio
    – A free, end-to-end platform for managing your lifecycle. Track your in a hosted registry to create a source of truth for everything in your graph. Studio provides an IDE (Apollo Explorer) so you can explore data, collaborate on queries, observe usage, and safely make schema changes.
  • Apollo Federation
    – The industry-standard open architecture for building a distributed . Use Apollo’s open-source gateway to compose a unified graph from multiple , determine a , and route requests across your services.
  • Apollo Client
    – The most popular for the web. Apollo also builds and maintains
    Apollo iOS
    and
    Apollo Android
    .
  • Apollo Server
    – A production-ready JavaScript that connects to any microservice, API, or database. Compatible with all popular JavaScript frameworks and deployable in environments.

Learn how to build with Apollo

Check out the

learning platform, the perfect place to start your journey with videos and interactive code challenges. Join the
Apollo Community
to interact with and get technical help from the community.

Next
Get started with Kotlin
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company