¿Cómo consumir una API Rest desde android?

Una de las tareas más comunes en la vida de un desarrollador es consumir una API Rest, ya que estas nos dan varias ventajas como compartir información entre aplicaciones sin importar en que lenguaje esten desarrolladas, entre este tipo de aplicaciones estan las aplicaciones móviles, las cuales en el mundo actual son verdaderamente importantes.

Para este ejercicio vamos a consumir la API de JSONPlaceholder para poder conseguir datos desde la API, usando código android y para este fin utilizaremos la librería Retrofit.

Retrofit es una librería muy poderosa para la realización de peticiones usando los verbos HTTP y que se puede configurar utilizando anotaciones de Java.

Cómo primer paso debemos agregar la siguiente línea en el Gradle de nuestro proyecto para agregar retrofit:

 implementation 'com.squareup.retrofit2:retrofit:2.4.0'

Además debemos agregar la librería converter-gson que nos permitirá serializar los datos que obtengamos para asi poder manipularlos, esta librería la agregamos con la siguiente línea en nuestro gradle:``

implementation 'com.squareup.retrofit2:converter-gson:2.4.0'

En el momento que hayamos agregado estás líneas en nuestro Gradle, Android Studio sincronizara nuestros cambios y agregará la librería al proyecto, una vez terminado este proceso debemos permitir que nuestra aplicación acceda a internet y esto lo podemos hacer con la siguiente línea en nuestro archivo AndroidManifest.xml:

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

Cabe destacar que esta etiqueta debe ser hija directa de la etiqueta manifest.

Como siguiente paso debemos crear el Pojo que va representar cada uno de los datos que vamos a estar recibiendo por medio de la API y como en este ejercicio vamos a estar consumiendo la siguiente URI POST, tendremos los siguientes datos:

Como podemos ver esta URI nos devuelve un JSON con un Array donde cada una de sus posiciones es un objeto con la información de un post, por lo cuál nuestro Pojo debe tener esos mismos campos para representar el post, entonces nuestro Pojo quedaría de la siguiente manera:

public class Post {
    private int userId;
    private int id;
    private String title;
    private String body;
    
    public int getUserId() {
        return userId;
    }

    public void setUserId(int userId) {
        this.userId = userId;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getBody() {
        return body;
    }

    public void setBody(String body) {
        this.body = body;
    }
}

Cómo siguiente paso crearemos una interfaz la cual nos servirá para gestionar cada una de nuestras peticiones a la API, en esta tendremos el siguiente código:

import java.util.List;

import retrofit2.Call;
import retrofit2.http.GET;

public interface PostService {

    String API_ROUTE = /posts";

    @GET(API_ROUTE)
    Call< List<Post> > getPost();

}

En esta interfaz simplemente estamos definiendo un string que nos va a representar la URI donde se va a realizar la petición y como anteriormente dijimos usamos anotaciones para indicarle a nuestro programa que el método que vamos a utilizar es el método GET y por último indicamos que tipo de datos queremos que devuelva nuestra llamada, en este caso nuestra llamada devolvera una lista de Post el cuál ya construimos anteriormente.

Ahora, en este ejercicio solo mostrare los title de los post en un ListView, teniendo esto en cuenta el siguiente paso es crear nuestro listView en el XML el cuál quedaría de la siguiente manera:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">
    <ListView
        android:id="@+id/list"
        android:layout_width="match_parent"
        android:layout_height="match_parent"></ListView>
</LinearLayout>

Ahora en nuestro activity debemos enlazar el ListView con el código Java y configurar el adaptador de nuestro ListView:

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.widget.ArrayAdapter;
import android.widget.ListView;

import java.util.ArrayList;

public class MainActivity extends AppCompatActivity {
    ListView list;
    ArrayList<String> titles = new ArrayList<>();
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ArrayAdapter arrayAdapter = new ArrayAdapter(this,android.R.layout.simple_list_item_1,titles);
        list = findViewById(R.id.list);
        
        list.setAdapter(arrayAdapter);
    }
}

Ya con esto hecho podemos proceder a hacer nuestra petición de la siguiente manera:

private void getPosts() {
        Retrofit retrofit = new Retrofit.Builder()
                            .baseUrl("https://jsonplaceholder.typicode.com")
                            .addConverterFactory(GsonConverterFactory.create())
                            .build();
        PostService postService = retrofit.create(PostService.class);
        Call< List<Post> > call = postService.getPost();

        call.enqueue(new Callback<List<Post>>() {
            @Override
            public void onResponse(Call<List<Post>> call, Response<List<Post>> response) {
                for(Post post : response.body()) {
                    titles.add(post.getTitle());
                }
                arrayAdapter.notifyDataSetChanged();
            }

            @Override
            public void onFailure(Call<List<Post>> call, Throwable t) {
            }
        });
    }

Primero que todo instaciamos el Builder de Retrofit el cuál sera el encargado de configurar nuestra petición y con el método baseUrl() agregamos la URL de la API, despues ejecutamos .addConverterFactory(GsonConverterFactory.create()) lo cuál nos permitirá serializar la respuesta de nuestra petición, como siguiente paso creamos un objeto de nuestra interfaz PostService y le asignamos el método retrofit.create() que nos recibe cómo parámetro nuestra interfaz.

El siguiente paso es crear una llamada a la cuál le indicamos que sera una llamada de tipo List< Post >, y le asignamos el metodo getPost() de nuestra interfaz PostService lo cual devuelve un Call, y ya para realizar la llamada ejecutamos el método enqueue() que recibe un objeto tipo Callback como parámetro y este ejecuta una clase anónima, que tiene dos métodos, el primero es el método onResponse(), que se ejecuta en caso que la llamada sea exitosa y en este método solamente actualizamos el listView con el título de cada uno de los post que nos devuelve el método body() del parámetro response y el onFailure() se ejecuta si algo falla en nuestra petición.

Al ejecutar el método getPosts() en el onCreate nuestra aplicación se veria algo asi:

Si quieres saber más sobre android les recuerdo que en EDteam tenemos excelentes cursos para aprender esta tecnología.Android desde ceroAndroid desde cero avanzado bases de datosAndroid desde cero avanzado - Firebase

Espero que les haya gustado, hasta la próxima.