Get request android kotlin

Kotlin HTTP GET/POST request

last modified January 26, 2021

Kotlin HTTP GET/POST request tutorial shows how to send a GET and a POST request in Kotlin. We use HttpClient and Fuel library.

The is an application protocol for distributed, collaborative, hypermedia information systems. HTTP is the foundation of data communication for the World Wide Web.

In the examples, we use httpbin.org , which is a freely available HTTP request and response service, and the webcode.me , which is a tiny HTML page for testing.

HTTP GET

The HTTP GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

HTTP POST

The HTTP POST method sends data to the server. It is often used when uploading a file or when submitting a completed web form.

Kotlin GET request with HttpClient

HttpClient is a tool for generating http requests in Java.

We create a GET request to the webcode.me webpage.

A client is created.

We build a synchronous request to the webpage. The default method is GET.

We send the request, retrieve the content of the response, and print it to the console.

This is the output.

GET query parameters with HttpClient

The following example appends some query parameters to the URL.

We create a GET request to the httpbin.org/get with some URL parameters.

This is a string extension method for encoding URL paramaters.

We have a map of values. We endcode them for the URL path with the custom extension method.

We append the parameters to the URL.

This is the output.

Kotlin POST JSON data request with HttpClient

The following example sends a POST request with HttpClient. The data is sent in JSON format.

For this example, we need the jackson-module-kotlin dependency.

We generate a POST request to the httpbin.org/post webpage. The post data are taken from a map and transformed into a string with Jackson’s ObjectMapper.

A POST request is generated via the POST method.

This is the output.

Kotlin POST FORM data request with HttpClient

With application/x-www-form-urlencoded the data is sent in the body of the request; the keys and values are encoded in key-value tuples separated by ‘&’, with a ‘=’ between the key and the value.

We generate a POST request with FORM data to httpbin.org/post .

We set the content type header to application/x-www-form-urlencoded .

With the String.uft8 and formData helper functions, we create a body publisher with url encoded values.

This is the output.

Kotlin GET request with Fuel

Fuel is an easy-to-use HTTP networking library for Kotlin.

We need to add the fuel dependency.

The example sends a simple GET request to webcode.me .

GET query parameters with Fuel

The following example sends some query parameters with the GET request.

The Fuel library automatically takes care of encoding the parameters in httpGet .

Kotlin POST JSON data request with Fuel

We set a POST request with JSON data. This time we use the Gson library.

We have additional dependencies for the Gson library.

We serialize the user object into a JSON string with the toJson method. We set a JSON body with the jsonBody method.

Kotlin POST FORM data request with Fuel

In the following example, we send a POST request with FORM data.

Fuel automatically tranforms the data to application/x-www-form-urlencoded content type in httpPost .

Источник

How to make POST, GET, PUT and DELETE requests with Retrofit using Kotlin

Retrofit is the most popular HTTP library and one of the most popular 3rd party libraries on Android.

Today, I’ll to show you how to do the following HTTP requests using Retrofit:

• POST request with the most commonly used MIME types:
  • application/json: Upload JSON data
  • multipart/form-data: Upload files (images, texts e.t.c)
  • application/x-www-form-urlencoded: Upload with the parameters encoded in the URL, for example https://myrestapi.com/post?name=Jack&age=45
• GET request and how to use @Path and @Query
• PUT request
• DELETE request

Retrofit not only can make HTTP requests but can also parse the JSON simultaneously.

I’m NOT going to show you how to parse the JSON data in this tutorial, but only how to make HTTP requests and print the results.

If you want to parse JSON with Retrofit, you need to read the current article first and then follow this.

Adding the libraries

Go to your app-level build.gradle file and add the following dependencies:

at the same file, at the bottom of the android section, add:

Adding Permissions & Preparing the Files

Go to the AndroidManifest.xml file and add the following permission:

Now, create a new Kotlin Interface file to put our @POST , @GET , @PUT , and @DELETE annotations later.

Right-click on your project name > New > Kotlin File/Class

Select Interface, name the file APIService and press Enter

After that, the file will look like this:

Adding data using POST method

To add data to the server, you need to use the HTTP request method POST.

Before you upload the data, you have to define what type of data you are uploading (e.g., raw JSON, media e.t.c). To do that, you need to set the MIME type.

• application/json for raw JSON data
• multipart/form-data for files, like images, pdfs, texts e.t.c
• application/x-www-form-urlencoded for passing the paramers encoded in the URL

• Uploading JSON data (application/json)

In this example, we’re going to POST the following data as raw JSON data in the URL: http://dummy.restapiexample.com/api/v1/create

• name: Jack
• salary: 3540
• age: 23

First, in the APIService.kt file add the following @POST annotation:

Then, to create the JSON we’ll use the JSONObject() class and add the data we want to upload.

So, at the end, the POST request will look like this:

• Uploading Files (multipart/form-data)

In this example, we’re going to POST a String value and a .txt file in the URL: https://httpbin.org/post

• email: jack@email.com
• file: lorem_ipsum.txt

First, in the APIService.kt file add:

As you see, we’re using HashMap to add the data (string and .txt file), alongside with Retrofit’s @PartMap annotation

…and the POST request will be:

• Uploading with parameters encoded in the URL (application/x-www-form-urlencoded)

To have the parameters encoded in the URL, all you have to do is to add the @FormUrlEncoded annotation in the APIService.kt file and use HashMap with the @FieldMap annotation.

And when you make the POST request, create a HashMap and add the parameters you want:

Retrieving data using GET method

To retrieve the data from the server, you need to use the HTTP request method GET.

Источник

Заправляйте HTTP-библиотеку с помощью Kotlin

1. Обзор

В этом руководстве мы рассмотрим топливную HTTP-библиотеку , которая, по словам автора, является самой простой сетевой библиотекой HTTP для Kotlin / Android. Кроме того, библиотеку также можно использовать в Java.

Основные возможности библиотеки:

• Поддержка основных HTTP-глаголов (GET, POST, DELETE и т. Д.) Как асинхронных, так и блокирующих запросов.
• Возможность скачивать и закачивать файл ( multipart / form-data )
• Возможность управлять глобальной конфигурацией
• Встроенные модули сериализации объектов (Jackson, Gson, Mhosi, Forge)
• Поддержка модуля сопрограмм Kotlin и RxJava 2.x
• Легко настроить шаблон проектирования маршрутизатора

2. Зависимости

Библиотека состоит из разных модулей, поэтому мы можем легко включить нужные нам функции. Некоторые из них включают:

• Модуль для поддержки RxJava и Kotlin Coroutines
• Модуль для поддержки компонентов архитектуры LiveData Android и Android
• Четыре модуля, из которых мы можем выбрать модуль сериализации объектов для использования — Gson, Jackson, Moshi или Forge.

В этом руководстве мы сосредоточимся на основном модуле, модулях для Coroutines, RxJava и модуле сериализации Gson:

Вы можете найти последние версии на JFrog Bintray.

3. Отправка запросов

Чтобы сделать запрос, Fuel предоставляет расширение String . Вдобавок и в качестве альтернативы мы можем использовать класс Fuel , у которого есть метод для каждого HTTP-глагола.

Fuel поддерживает все HTTP-команды, кроме PATCH. Причина в том, что HttpClient от Fuel — это оболочка над java.net.HttpUrlConnection, которая не поддерживает PATCH.

Чтобы решить эту проблему, HttpClient преобразует запросы PATCH в запрос POST и добавляет заголовок X-HTTP-Method-Override: PATCH , поэтому нам нужно убедиться, что наши API-интерфейсы настроены для приема этого заголовка по умолчанию.

Чтобы объяснить особенности Fuel, мы собираемся использовать httpbin.org, простой сервис HTTP-запросов и ответов, и JsonPlaceholder — поддельный онлайн-API для тестирования и создания прототипов.

3.1. Получить запрос

Приступим к созданию простого HTTP- запроса GET в асинхронном режиме:

Использование httpGet () над String дает нам Triple .

Результат представляет собой структуру данных функционально-стиль , который содержит результат операции (успех или неудача). Мы вернемся к структуре данных Result на более позднем этапе.

Также мы можем сделать запрос в режиме блокировки:

Обратите внимание, что возвращаемые параметры такие же, как и для асинхронной версии, но в этом случае поток, выполнивший запрос, блокируется.

Также есть возможность использовать закодированные параметры URL:

Метод httpGet () (и другие подобные) может получать список для кодирования параметров URL.

3.2. POST запрос

Мы можем сделать POST запросы точно так же , как и для GET, используя HttpPost () или с помощью поста () метода топлива класса:

Если у нас есть тело, мы можем передать его через метод body () в строковом формате JSON:

3.3. Другие глаголы

Как и для GET и POST, для каждого из оставшихся глаголов есть метод:

Помните, что Fuel.patch () выполнит запрос POST с заголовком X-HTTP-Method-Override: PATCH .

4. Конфигурация

Библиотека предоставляет одноэлементный объект — FuelManager.instance — для управления глобальной конфигурацией.

Давайте настроим базовый путь, некоторые заголовки и общие параметры. Также давайте настроим некоторые перехватчики.

4.1. BasePath

Используя переменную basePath, мы можем установить общий путь для всех запросов.

4.2. Заголовки

Кроме того, мы можем управлять общими заголовками HTTP с помощью карты baseHeaders :

В качестве альтернативы, если мы хотим установить локальный заголовок, мы можем использовать метод header () для запроса:

4.3. Params

Наконец, мы также можем установить общие параметры, используя список baseParams :

4.4. Другие опции

Есть еще много вариантов, которыми мы можем управлять через FuelManager:

• хранилище ключей, которое по умолчанию имеет значение null
• socketFactory, который будет предоставлен пользователем или получен из хранилища ключей, если он не равен нулю
• hostnameVerifier that is set by default to use the one provided by HttpsURLConnection class
• requestInterceptors and responseInterceptors
• timeout and timeoutRead for a request

4.5. Request/Response Interceptors

Regarding interceptors, we can add supplied request/response interceptors like cUrlLoggingRequestInterceptors(), or we can define ours:

5. Response Handling

Previously, we introduced a functional data structure – Result – that represents the operation result (success or failure).

Working with Result is easy, it is a data class that can contain the response in ByteArray, String, JSON, or a generic T object:

Let’s get a response as a String to illustrate this:

Note that the response in JSON format requires Android dependencies.

6. JSON Serialization/Deserialization

Fuel provides built-in support for response deserialization with four methods which, depending on our needs and on the JSON parsing library we choose, we’re required to implement:

By including the Gson module we can deserialize and serialize objects:

We can deserialize objects with custom deserializer:

Or via responseObject which uses internal Gson deserializer:

On the other hand, we can serialize using Gson().toJson():

It’s important to set the Content-Type, otherwise, the server may receive the object within another JSON object.

Eventually, in a similar way, we can do it by using Jackson, Moshi or Forge dependencies.

7. Download and Upload File

The Fuel library includes all the necessary features to download and upload files.

7.1. Download

With the download() method we can easily download a file and save it into the file returned by the destination() lambda:

We can also download a file with a progress handler:

7.2. Upload

In the same way, we can upload a file using upload() method, indicating the file to upload with the source() method:

Note that upload() uses the POST verb by default. If we want to use another HTTP verb we can specify it:

Moreover, we can upload multiple files using sources() method which accepts a list of files:

Lastly, we can upload a blob of data from an InputStream:

8. RxJava and Coroutines Support

Fuel provides support for RxJava and Coroutines, two way of writing asyncrhonus, non-blocking code.

RxJava is a Java VM implementation of Reactive Extensions, a library for composing asynchronous and event-based programs.

It extends the Observer pattern to support sequences of data/events and adds operators that allow composing sequences together declaratively without worrying about synchronization, thread-safety, and concurrent data structures.

Kotlin’s Coroutines are like light-weight threads and, as such, they can run in parallel, wait for each other and communicate… The biggest difference is that coroutines are very cheap; we can create thousands of them, and pay very little in terms of memory.

8.1. RxJava

To support RxJava 2.x, Fuel provides six extensions:

Note that, to support all different response types, each method returns a different Single .

We can easily use “Rx” methods by invoking the more relevant one over a Request:

8.2. Coroutines

With the coroutines module, Fuel provides extension functions to wrap a response inside a coroutine and handle its result.

To use Coroutines, similar APIs are made available, e.g responseString() became awaitStringResponse():

It also provides useful methods for handling objects other than String or ByteArray (awaitByteArrayResponse()) using awaitObject(), awaitObjectResult() or awaitObjectResponse():

Remember that Kotlin’s Coroutines are experimental, which means that it might be changed in the upcoming releases.

9. API Routing

Last but not least, in order to handle network routes, Fuel provides the support by implementing the Router design pattern.

With the router pattern, we can centralize the management of the API using the FuelRouting interface, which provides a combination of methods for setting the appropriate HTTP verb, path, params and headers according to the endpoint called.

The interface defines five properties by which it is possible to configure our Router:

In order to choose which HTTP verb to use we have method property, likewise, we can override the path property, so as to choose the appropriate path.

Even more with the params property, we have the opportunity to set the parameters of the request and if we need to set HTTP headers, we can do it overriding the concerning property.

Следовательно, мы используем его так же, как и во всем руководстве, с методом request () :

10. Заключение

В этой статье мы показали HTTP-библиотеку Fuel для Kotlin и ее более полезные функции для любого случая использования.

Библиотека постоянно развивается, поэтому загляните в их репозиторий GitHub — чтобы отслеживать новые функции.

Как обычно, все фрагменты кода, упомянутые в руководстве, можно найти в нашем репозитории GitHub.

Источник