January 22, 2021

Как создать API-обертку на Java на примере Utopia Client API

С чего начать?

Сначала скачиваем клиент Utopia с официального сайта: https://u.is/ru/download.html

Запускаем, создаем аккаунт. Как скачать и установить клиент вы можете узнать в статье: Как скачать клиент Utopia.

Для начала давайте разберемся со структурой нашей библиотеки для API. Делать по итогу мы будем jar, чтобы удобно подключать к своим другим решениям созданную нами обертку.
  1. У нас будет класс лишь с 2 свойствами. Оба свойства типа string - ибо отправлять мы будем запрос json.
    1 свойство - токен для подключения к клиенту.
    2 свойство - порт, ну надо же знать к какому порту.
пример

2. Методы, они очевидно будут дублировать заголовки выбранного api, для удобства. Далее рассмотрим более подробно, что понадобится для того, чтобы нормально реализовать их.

Что понадобится для реализации?

  1. То, без чего не будут работать наши методы - библиотека org.json. Идем, качаем jar , подключаем - ссылка. Ну и конечно не забываем посмотреть как работает это чудо - ссылка.

2. Нужно понять как делать http request, ссылочку на информацию любезно предоставляю - тык.

Это всё, далее рассмотрим немного более подробно что нужно делать с этим нашем методом.

Реализуем метод!

Кратко как это работает:
  1. Создаем заголовок.
  2. Создаем строку которую будем возвращать, т.е в ней будет ответ сервера.
пример

3. Задаем настройки для подключения к серверу.

пример

4. Создаем нужный нам json объект.

пример

5. Создаем ещё одну строку, чтобы записать в неё наш json объект, делаем json запрос с этой строкой и возвращаем ответ, если оно надо (помните мы создавали строку flimp). Готово! Рабочий метод, идем тестировать!

пример

Заканчиваем начатое...

Собственно, что тут сказать, тестируем нашу библиотеку, создаем jar файл, подключаем к своим проектам. Profit! Пример полной версии кода - тык.