Making use of open REST API with Retrofit
If you look on application landscape in any big company you probably see that it is composed of multiple separate applications that communicate with each other. And such communication might be quite challenging if there is no standard way, protocol, to resolve it. Luckily, Application Programming Interface (API) is for a rescue!
So what exactly is API?
In short it is a set of rules, functions, by which applications can interacts with each other. And by interacting I mean fetching the data (usually in a form of JSON or XML files) or by changing state of receiving system (modify database etc.).
Ok, now what is REST?
It stands for Representational State Transfer and is a design pattern that is typically used in web application to expose its state and resources to the clients and it relays on HTTP protocol methods (GET, POST, PUT, DELETE).
In other words, REST API is a service of an application that expose its functionality and make it accessible for other applications via HTTP requests. And a good thing is that it is us, developers, who can define what part of the application we would like to expose. Do you want to allow others to see only small part of your application? No problem, it is you who defines what to show.
In this blog post I will focus on receiving part of the communication. Building own REST API is much more complex topic, but I’ll cover it in future, in my next project.
Everything is a little bit abstract. Do you have any example?
Sure, there are plenty open source API that can be used. A cool list can be found here, where all of them are sorted by categories. Many organizations from outside this list provide free API, so if you are interested in particular field just try to dig in it on their website.
For example, you can use YouTube API to search for videos, updating them to service and so on. Most of them, like YouTube, requires additional authentication to make it more secure or to manage its traffic. The most popular ways are:
- API key included in the request URL or header,
- Basic authorization,
- OAuth 2.0 protocol.
A way to achieve is very different depending on API provider, but usually it is only a simple registration (for open source).
In my project, Library Portal, I want to make use of a Random Quote API to inspire users whenever they log into the application 😉. One of a reason why I’ve chosen this API is that it is free and really simple to use.
From official website we can read that in order to get a random quote you need to use bellow address:
https://talaikis.com/api/quotes/random/As we want to fetch the data, we want to use GET method of HTTP protocol, the same that web browser use to get HTML page. And so if it is the same method, we can test it on our web browser. After typing above URL you should get something like this:
As a result we receive a simple JSON file that contains three pairs of key-value separated with colon “:” that describes a Random Quote object. If you need more information about JSON syntax check this link (also in the References section).
Retrofit 2.0 — simple way to consume REST API
All right, I get what REST API is and what could be the respond, but how to translate it into Java code?
Your first idea probably was to create own JSON parser, but such approach could be error prone and it could take a lot of time, especially in more complex cases. Luckily we’ve got Retrofit 2.0 library that allows us to mange it really smoothly.
Work on implementing Retrofit can be divided into three stages:
- Map REST respond to the Java model class
- Define interface for REST API methods
- Create class that will use REST API interface and respond model
Map REST respond to the Java model class
REST API respond can be represented in Java with simple POJO, so its fields name will be keys of JSON respond. In our example it looks as follows:
You may notice that I’ve omitted “cat” key. One of the cool things of Retrofit is that you don’t need to map all keys, only those that you need.
Our example is very simple, but in usually the JSON structure is not so simple, which makes mapping very arduous. To overcome it you can visit a website which will generate a POJO for you, just by providing the sample JSON.
Define interface for REST API methods
Next we need to map REST API request to the Java interface class. Below there is a snippet for Random Quotes:
Each method in the interface represents one possible API call. In our example we make a use on one of them and therefore we have only single method.
This method is annotated with @GET, which tells Retrofit to use HTTP GET method on specific web resource (“/api/quotes/random/”) of a base URL (it will be introduced in next step).
Except for @GET annotation there @POST, @DELETE, @PUT that are used for correspond HTTP methods.
The return type of interface method must be always Call<T>, where T is an object that represents the API respond (defined in previous section).
Our example is really simple. It doesn’t contain any dynamic path or parameter, but most APIs requires to provide information what resource we would like to fetch/modify. We can take care of it in two ways.
First, we can add markup into resource path, which will be specified between two brackets {}. For example, URL for retrieving book from Google Book API is https://www.googleapis.com/books/v1/volumes/{googleId}, where in a place of {googleId} should be a resource unique key. Another way to specify resource would be via request parameter at the end of the URL.
Below there is a code snippet of both these ways.
In order to pass value either to resource path or request parameter we need to add arguments to the method that are annotated with @Path and @Query respectively. With a base URL, googleId (“wrOQLV6xB-wC”)and API key (“Top_Secret_Key”) a resulting URL would be:
https://www.googleapis.com/wrOQLV6xB-wC?key=Top_Secret_KeyCreate class that will use REST API interface and respond model
Finally we need to put together both classes. Here is the method that covers this task.
Above code will be valid most of the time. First we need to create a Retrofit object. It requires several parameters like base URL or converter factory. The latter one depends on the respond type (JSON, XML, etc.). The most popular for JSON is GsonConverterFactory. List of available converter factories can be found here.
Another object that can be passed to Retrofit object is an adapter, which extends Retrofit capability to integrate with some external libraries, e.g. with RxJava 2. List of available adapters can be found here.
In next part we create object that implements our interface (Retrofit is doing that) and make a synchronous call to retrieve RandomQuoteResponse object.
We could also make an asynchronous call which would like as follows:
Writting code
In previous section I’ve shown a simple API example, now I’ll cover all steps that for more complex one — Google Book. In the Library Portal I want to be able to search for books in Google’s API and then adding them to the library. To achieve it I make a use of Retrofit.
The URL to fetch data from Google API is:
https://www.googleapis.com/ books/v1/volumes?langRestrict=en&maxResults=40&printType=books&key=My_Key&q=book_titleThere are several parameters that I’ve included in the URL:
- langRestrict — defines in which language I want to find resources,
- maxResults — number of maximum results per query, maximum allowable value is 40,
- printType — what print type (books, newspaper, etc.) to find,
- key — Google API key
- q — query to search for a book
There are more parameters available than above ones. The whole list with examples could be find on official the website of Google Book API here:
Step 0. Get an API key from Google
This step will vary depending on an API provider. In my case it is Google, which provides two types of authorization: API key and OAuth2. I’ve decided to use API key, as it is more simple way 😉.
To get an API key first you need to have Google Account. To create it go to:
After registration (if you don’t how an account), go to Credentials page:
During first login, you will be asked to create new project so create it. Next, on the left-hand side you should have a menu, from which select Credentials.
You should get a screen where Create credentials button is visible. Click it and from the list pick API key. Your key should appear on a screen.
If you need more information about using Google Books APIs go to:
Step 1. Add dependencies to build.gradle file
First, add dependency to the Gradle build file (within dependencies brackets) in your project.
compile 'com.squareup.retrofit2:retrofit:2.4.0'
compile 'com.squareup.retrofit2:converter-gson:2.4.0'Step 2. Create model classes
Before creating model classes we need to analyze the API respond, so if we want to find books that are related to ‘game of thrones’ we would use following query (sign %20 is equivalent of blank space):
https://www.googleapis.com/books/v1/volumes?langRestrict=en&maxResults=40&printType=books&key=My_Key&q=game%20of%20thronesand as a result we get following JSON (for better readability I advice to install web browser plugin for JSONs when you will be testing API on your own):
{kind: "books#volumes",totalItems: 422,items:[ { kind: "books#volume", id: "l6xMUQ88vLAC", etag: "VSXB8iRfRxQ", selfLink: "https://www.googleapis.com/books/v1/volumes/l6xMUQ88vLAC", volumeInfo:{ title: "Re-Reading a Game of Thrones", subtitle: "A Critical Response to George R. R. Martin's Fantasy Classic", authors:["Remy J. Verhoeve"], publisher: "Nimble Books LLC", publishedDate: "2011-04", description: "In 1996, George R.R. Martin electrified fantasy fans around the world when he published A Game of Thrones, the first book in his acclaimed A Song of Ice and Fire series. Since then, Martin has published three more books in the series. The engrossing tale Martin spun with these first novels in his saga has gained more and more fans across the world and has resulted in a number of spin-off products, such including HBO's TV series, card and board games, computer games, sword replicas, comic books and calendars. Perhaps paradoxically, the number of years between each time Martin publishes a new book in the series has increased. Fans have been clamoring for the fifth volume, A Dance with Dragons, since 2005: A book that promises to pick up the storylines of fan-favorite characters left hanging since 1999. As Martin struggles to reach the finish line, or indeed even the halfway point in his epic, his fans wait for the next fix. One way to keep sane during the long waits is to re-read the already published novels. Journey to Westeros with Remy J. Verhoeve as he celebrates his tenth reading of A Game of Thrones. Chapter by chapter, the author, a Dutch-Norwegian English teacher and self-confessed fantasy geek, is both fellow traveler and tour guide as he shares his insightful reflections on Martin's writing techniques, major - and seemingly minor - plot points and characters, and much more. True to its origins as a blogging project undertaken while not-so-patiently waiting for A Dance With Dragons, the author does not hold back in this unauthorized companion book that is both an unabashed homage to the novel that started it all, as well as a candid - and at times controversial - commentary on the issues surrounding the delayed release of the fifth book. Whether or not they agree with everything the author has to say, all fans of A Song of Ice and Fire, from those who have loved the series since its inception in 1996 to those who have only just discovered it through the HBO series, will enjoy this thought-provoking and outspoken book.", industryIdentifiers:[
{type: "ISBN_13", identifier: "9781608881154"}, {type: "ISBN_10", identifier: "1608881156"} ], readingModes: { text: true, image: true }, pageCount: 372, printType: "BOOK", categories:["Literary Criticism"], averageRating: 5, ratingsCount: 1, maturityRating: "NOT_MATURE", allowAnonLogging: true, contentVersion: "0.0.1.0.preview.3", panelizationSummary:{ containsEpubBubbles: false, containsImageBubbles: false }, imageLinks:{ smallThumbnail: "http://books.google.com/books/content?id=l6xMUQ88vLAC&printsec=frontcover&img=1&zoom=5&edge=curl&source=gbs_api", thumbnail: "http://books.google.com/books/content?id=l6xMUQ88vLAC&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api" }, language: "en", previewLink: "http://books.google.pl/books?id=l6xMUQ88vLAC&printsec=frontcover&dq=game+of+thrones&hl=&as_pt=BOOKS&cd=1&source=gbs_api", infoLink: "http://books.google.pl/books?id=l6xMUQ88vLAC&dq=game+of+thrones&hl=&as_pt=BOOKS&source=gbs_api", canonicalVolumeLink: "https://books.google.com/books/about/Re_Reading_a_Game_of_Thrones.html?hl=&id=l6xMUQ88vLAC" }, saleInfo:{ country: "PL", saleability: "NOT_FOR_SALE", isEbook: false }, accessInfo:{ country: "PL", viewability: "PARTIAL", embeddable: true, publicDomain: false, textToSpeechPermission: "ALLOWED", epub:{ isAvailable: true, acsTokenLink: "http://books.google.pl/books/download/Re_Reading_a_Game_of_Thrones-sample-epub.acsm?id=l6xMUQ88vLAC&format=epub&output=acs4_fulfillment_token&dl_type=sample&source=gbs_api" }, pdf:{ isAvailable: true, acsTokenLink: "http://books.google.pl/books/download/Re_Reading_a_Game_of_Thrones-sample-pdf.acsm?id=l6xMUQ88vLAC&format=pdf&output=acs4_fulfillment_token&dl_type=sample&source=gbs_api" }, webReaderLink: "http://play.google.com/books/reader?id=l6xMUQ88vLAC&hl=&as_pt=BOOKS&printsec=frontcover&source=gbs_api", accessViewStatus: "SAMPLE", quoteSharingAllowed: false }, searchInfo:{ textSnippet: "In 1996, George R.R. Martin electrified fantasy fans around the world when he published A Game of Thrones, the first book in his acclaimed A Song of Ice and Fire series. Since then, Martin has published three more books in the series." }},
///more results
]}
From above output you can see that API provides a huge variety of information. I don’t want to map all of them, just the most essentials for my purpose, so my classes contain only these fields. For simplicity I haven’t included any getters and setters method that are required (or you can use project Lombok).
Step 3. Create API interface
Once we have model classes than we need to create an interface for specific API call, which should like this:
Step 4. Create API service
And next we need to design API Service class to create new Retrofit object and retrieve data.
You’ve probably notice @Component and @PropertySource above class declaration. These are Spring-specific, first one is responsible for registering class to Spring context, latter for getting properties file which contains my API key, which Spring will inject for me (with @Value annotation).
Step 5. Test
And finally we can make a test for above implementation that will be:
First, it tests if Google Books Service bean has been injected, and then if it retrieves a result for a search query “game of thrones”. Both tests passed and the outcome in the console is:
[ItemAPIModel( id=l6xMUQ88vLAC, volumeInfo=VolumeInfoModel( title=Re-Reading a Game of Thrones, authors=[Remy J. Verhoeve], publisher=Nimble Books LLC, publishedDate=2011-04, description=In 1996, George R.R. Martin electrified fantasy fans around the world when he published A Game of Thrones, the first book in his... //further description industryIdentifiers=[ IsbnAPIModel(type=ISBN_13, identifier=9781608881154) IsbnAPIModel(type=ISBN_10, identifier=1608881156)], pageCount=372, categories=[Literary Criticism], averageRating=5.0, imageLinks=ImageLinksAPIModel(thumbnail=http://books.google.com/books/content?id=l6xMUQ88vLAC&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api))),///more results]
As usual, here is a link to project source code:
