Making GET Requests and Handling Responses with OkHttp in Kotlin

Making GET Requests and Handling Responses

Welcome to the second lesson in our journey of interacting with APIs in Kotlin . Previously, we laid a strong foundation by understanding RESTful APIs and using manual tools to craft and send a GET request to an endpoint. Now, we are transitioning to automate this process using libraries, specifically OkHttp . While Kotlin's standard library provides basic HTTP functionalities, OkHttp excels with its user-friendly API and robust capabilities for handling HTTP requests more efficiently and smoothly. This makes it an invaluable tool in web development and API integration, providing features like connection pooling, transparent GZIP, and response caching, which go beyond the basic functionalities offered by the native options.

Setting Up the Environment

To make HTTP requests in Kotlin, we will use the OkHttp library, a user-friendly and powerful library for handling HTTP requests. If you are working within an IDE like IntelliJ IDEA, you can integrate OkHttp by adding the following line to your build.gradle file in the dependencies section if you're using Gradle: Kotlin dependencies {implementation("com.squareup.okhttp3:okhttp:4.9.3") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")} dependencies {implementation("com.squareup.okhttp3:okhttp:4.9.3") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")} After adding the dependencies, make sure to sync your project to include the necessary libraries.

Setting Up Serialization

Setting up JSON serialization is crucial for parsing responses because it allows us to convert JSON data from the API into Kotlin objects that we can easily manipulate in our code. This offers a seamless integration between the data formats used by web services and the Kotlin programming language, significantly simplifying the process of handling JSON data. To do this you need to add the kotlinx serialization library: Kotlin dependencies {implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")} dependencies {implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")} And don't forget to apply the plugin: Kotlin plugins {kotlin("plugin.serialization") version "1.5.30"} plugins {kotlin("plugin.serialization") version "1.5.30"}

Defining the Base URL

When interacting with an API, it's helpful to define a base URL for the service you're communicating with. This makes your code more modular and easy to maintain, allowing you to change the root of your API URL in one place without modifying each request. Kotlin // Base URL for the API val baseUrl = "http://localhost:8000" // Base URL for the API val baseUrl = "http://localhost:8000" By setting this base URL, we can easily concatenate endpoints for different services within the API, making our code cleaner and more adaptable. APIs often run on specific ports to separate different services or applications on the same server. In local development, localhost typically refers to 127.0.0.1, the local loopback address, but the API server must still be listening on the specified port. The default HTTP port is 80, and HTTPS is 443, but many development APIs use custom ports (e.g., 8000 in this case). Ensure that the API server is running on the correct port before making requests, as an incorrect port leads to connection failures.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Kotlin

dependencies {
    implementation("com.squareup.okhttp3:okhttp:4.9.3")
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")
}

Kotlin

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.2")
}

Kotlin

plugins {
    kotlin("plugin.serialization") version "1.5.30"
}

Kotlin

// Base URL for the API
val baseUrl = "http://localhost:8000"

Kotlin

import okhttp3.OkHttpClient
import okhttp3.Request
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Define a data class to represent a to-do item; each property corresponds to a JSON field
@Serializable
data class Todo(
    val description: String,
    val done: Boolean,
    val id: Int,
    val title: String
)

fun fetchTodos() {
    // Initialize the OkHttpClient which will be used to send requests
    val client = OkHttpClient()

    // Build a GET request to the /todos endpoint, appended to the base URL
    val request = Request.Builder()
        .url("$baseUrl/todos")
        .build()

    // Execute the request and handle the response
    client.newCall(request).execute().use { response ->
        // Print the raw response body received from the server
        println("Raw Response:")
        println(response.body?.string())
    }
}

fetchTodos()

import okhttp3.OkHttpClient
import okhttp3.Request
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Define a data class to represent a to-do item; each property corresponds to a JSON field
@Serializable
data class Todo(
    val description: String,
    val done: Boolean,
    val id: Int,
    val title: String
)

fun fetchTodos() {
    // Initialize the OkHttpClient which will be used to send requests
    val client = OkHttpClient()

    // Build a GET request to the /todos endpoint, appended to the base URL
    val request = Request.Builder()
        .url("$baseUrl/todos")
        .build()

    // Execute the request and handle the response
    client.newCall(request).execute().use { response ->
        // Print the raw response body received from the server
        println("Raw Response:")
        println(response.body?.string())
    }
}

fetchTodos()

Kotlin

client.newCall(request).execute().use { response ->
    // Check if the server response status code is 200 (OK)
    if (response.code == 200) {
        println("Todos retrieved successfully:")

        // Get the response body as a string
        val json = response.body?.string() ?: ""

        // Deserialize the JSON string into a list of Todo objects using kotlinx.serialization
        val todos = Json.decodeFromString<List<Todo>>(json)

        // Iterate through the list of Todo objects and print each one
        todos.forEach { todo ->
            println("Title: ${todo.title}, Description: ${todo.description}, Done: ${todo.done}")
        }
    }
}

Kotlin

// Check if the server response status code is 400 (Bad Request)
if (response.code == 400) {
    println("\nBad Request. The server could not understand the request due to invalid syntax.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details for further analysis
    println("Error Details: $error")
}

// Check if the server response status code is 400 (Bad Request)
if (response.code == 400) {
    println("\nBad Request. The server could not understand the request due to invalid syntax.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details for further analysis
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 401 (Unauthorized)
if (response.code == 401) {
    println("\nUnauthorized. Access is denied due to invalid credentials.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the authentication issue
    println("Error Details: $error")
}

// Check if the server response status code is 401 (Unauthorized)
if (response.code == 401) {
    println("\nUnauthorized. Access is denied due to invalid credentials.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the authentication issue
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 404 (Not Found)
if (response.code == 404) {
    println("\nNot Found. The requested resource could not be found on the server.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to determine what might be missing or incorrect
    println("Error Details: $error")
}

// Check if the server response status code is 404 (Not Found)
if (response.code == 404) {
    println("\nNot Found. The requested resource could not be found on the server.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to determine what might be missing or incorrect
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 500 (Internal Server Error)
if (response.code == 500) {
    println("\nInternal Server Error. The server has encountered a situation it doesn't know how to handle.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the server-side issue
    println("Error Details: $error")
}

// Check if the server response status code is 500 (Internal Server Error)
if (response.code == 500) {
    println("\nInternal Server Error. The server has encountered a situation it doesn't know how to handle.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the server-side issue
    println("Error Details: $error")
}

Kotlin

// Handle any unexpected status codes that do not fall into predefined categories
else {
    println("\nUnexpected Status Code: ${response.code}")

    // Retrieve the response body which may contain additional information
    val error = response.body?.string()

    // Print the error details to help diagnose unexpected responses
    println("Error Details: $error")
}

// Handle any unexpected status codes that do not fall into predefined categories
else {
    println("\nUnexpected Status Code: ${response.code}")

    // Retrieve the response body which may contain additional information
    val error = response.body?.string()

    // Print the error details to help diagnose unexpected responses
    println("Error Details: $error")
}

Kotlin

import okhttp3.OkHttpClient
import okhttp3.Request
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Define a data class to represent a to-do item; each property corresponds to a JSON field
@Serializable
data class Todo(
    val description: String,
    val done: Boolean,
    val id: Int,
    val title: String
)

fun fetchTodos() {
    // Initialize the OkHttpClient which will be used to send requests
    val client = OkHttpClient()

    // Build a GET request to the /todos endpoint, appended to the base URL
    val request = Request.Builder()
        .url("$baseUrl/todos")
        .build()

    // Execute the request and handle the response
    client.newCall(request).execute().use { response ->
        // Print the raw response body received from the server
        println("Raw Response:")
        println(response.body?.string())
    }
}

fetchTodos()

Kotlin

client.newCall(request).execute().use { response ->
    // Check if the server response status code is 200 (OK)
    if (response.code == 200) {
        println("Todos retrieved successfully:")

        // Get the response body as a string
        val json = response.body?.string() ?: ""

        // Deserialize the JSON string into a list of Todo objects using kotlinx.serialization
        val todos = Json.decodeFromString<List<Todo>>(json)

        // Iterate through the list of Todo objects and print each one
        todos.forEach { todo ->
            println("Title: ${todo.title}, Description: ${todo.description}, Done: ${todo.done}")
        }
    }
}

Kotlin

// Check if the server response status code is 400 (Bad Request)
if (response.code == 400) {
    println("\nBad Request. The server could not understand the request due to invalid syntax.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details for further analysis
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 401 (Unauthorized)
if (response.code == 401) {
    println("\nUnauthorized. Access is denied due to invalid credentials.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the authentication issue
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 404 (Not Found)
if (response.code == 404) {
    println("\nNot Found. The requested resource could not be found on the server.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to determine what might be missing or incorrect
    println("Error Details: $error")
}

Kotlin

// Check if the server response status code is 500 (Internal Server Error)
if (response.code == 500) {
    println("\nInternal Server Error. The server has encountered a situation it doesn't know how to handle.")

    // Retrieve the response body which contains error details
    val error = response.body?.string()

    // Print the error details to understand the server-side issue
    println("Error Details: $error")
}

Kotlin

// Handle any unexpected status codes that do not fall into predefined categories
else {
    println("\nUnexpected Status Code: ${response.code}")

    // Retrieve the response body which may contain additional information
    val error = response.body?.string()

    // Print the error details to help diagnose unexpected responses
    println("Error Details: $error")
}

Making GET Requests and Handling Responses

Setting Up the Environment

Setting Up Serialization

Defining the Base URL

Join the 1M+ learners on CodeSignal

Performing a Basic GET Request

Handling Successful Requests (Status Code: 200)

Handling Bad Requests (Status Code: 400)

Handling Unauthorized Requests (Status Code: 401)

Handling Not Found Errors (Status Code: 404)

Handling Internal Server Errors (Status Code: 500)

Handling Unexpected Status Codes

Conclusion, Key Takeaways, and Next Steps