retro-cat-app's Introduction

The Cat App

A cute cat app to learn about Retrofit

Retrofit is a type-safe HTTP client for Android and Java. It's a standard and easy tool to consume APIs used by Android developers community

This App use TheCatApi to make requests, check the docs and get your API Key for free

Screenshot

To make request using Retrofit follow the steps below:

1. Add Retrofit dependencies (build.gradle)

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
}

2. Give permission (AndroidManifest.xml)

<uses-permission android:name="android.permission.INTERNET"/>

3. Create your data class

data class Kitty(
	@field:SerializedName("name")
	val name: String
)

4. Declare your End Points

interface CatAPI {
    @GET("breeds")
    fun getBreeds(): Call<List<Kitty>>

    @Headers("x-api-key: xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx")
    @GET("breeds/search")
    fun getKitty(@Query("q") breedCode: String): Call<List<Kitty>>
}

5. Build your client

val retrofitClient = Retrofit.Builder()
    .baseUrl("https://api.thecatapi.com/v1/")
    .addConverterFactory(GsonConverterFactory.create())
    .build()

val endpoint = retrofitClient.create(CatAPI::class.java)

6. Implement your callbacks

val callback = endpoint.getBreeds()
callback.enqueue(object : Callback<List<Kitty>> {
    override fun onFailure(call: Call<List<Kitty>>, t: Throwable) {
        Toast.makeText(requireContext(), t.message, Toast.LENGTH_SHORT).show()
    }

    override fun onResponse(call: Call<List<Kitty>>, response: Response<List<Kitty>>) {
        response.body()?.let {
            myAdapter.setListItems(it)
        }
    }
})