Automating API Requests in Kotlin

Welcome to the second lesson in our series on interacting with APIs in Kotlin. Up until now, we've looked at RESTful APIs and learned how to manually send a GET request. Today, we'll automate this process further using Kotlin, exploring native methods for making HTTP requests. This approach streamlines the process and removes external dependencies, promoting a more integrated handling of HTTP interactions in Kotlin applications.

Let's start by fetching data from an API using Kotlin's standard library for HTTP operations. Our goal is to retrieve a list of to-do items from the /todos endpoint using the GET method.

import java.net.HttpURLConnection
import java.net.URL
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() {
    // Define the URL for the GET request
    val url = URL("http://localhost:8000/todos")
    
    // Open connection
    with(url.openConnection() as HttpURLConnection) {
        requestMethod = "GET"  // Optional, default is GET
        
        println("Raw Response:")
        
        // Read and print the response
        inputStream.bufferedReader().use {
            val response = it.readText()
            println(response)
        }
    }
}

fun main() {
    fetchTodos()
}

The code for performing a basic GET request in Kotlin demonstrates how to fetch data from a specified URL using Kotlin's standard library for HTTP operations. The process involves several steps:

1. Import Necessary Libraries: The code imports classes from the java.net package for URL connections and kotlinx.serialization for handling JSON serialization and deserialization.

2. Define a Data Class: The Todo data class is defined with properties: description, done, id, and title. These correspond to the fields expected in the JSON response from the API.

3. fun fetchTodos(): This function is responsible for making the GET request.

   • Define the URL: The URL object is created with the endpoint http://localhost:8000/todos.

   • Open Connection: The openConnection() method is called on the URL object, returning an instance of HttpURLConnection.

   • Set Request Method: The request method is explicitly set to "GET", though it is optional as GET is the default method.

4. Read and Print the Response: The response from the server is read using an input stream that is wrapped in a bufferedReader(). The use function ensures that the reader is closed after the operation. The response text is printed to the console.

5. Main Function: The main function calls fetchTodos() to execute the GET request.

This setup provides a simple, native method for performing HTTP GET requests in Kotlin without external dependencies.