Как создать API-обертку на Java на примере Utopia Client API
С чего начать?
Сначала скачиваем клиент Utopia с официального сайта: https://u.is/ru/download.html
Запускаем, создаем аккаунт. Как скачать и установить клиент вы можете узнать в статье: Как скачать клиент Utopia.
Для начала давайте разберемся со структурой нашей библиотеки для API. Делать по итогу мы будем jar, чтобы удобно подключать к своим другим решениям созданную нами обертку.
- У нас будет класс лишь с 2 свойствами. Оба свойства типа string - ибо отправлять мы будем запрос json.
1 свойство - токен для подключения к клиенту.
2 свойство - порт, ну надо же знать к какому порту.
2. Методы, они очевидно будут дублировать заголовки выбранного api, для удобства. Далее рассмотрим более подробно, что понадобится для того, чтобы нормально реализовать их.
Что понадобится для реализации?
- То, без чего не будут работать наши методы - библиотека org.json. Идем, качаем jar , подключаем - ссылка. Ну и конечно не забываем посмотреть как работает это чудо - ссылка.
2. Нужно понять как делать http request, ссылочку на информацию любезно предоставляю - тык.
Это всё, далее рассмотрим немного более подробно что нужно делать с этим нашем методом.
Реализуем метод!
Кратко как это работает:
- Создаем заголовок.
- Создаем строку которую будем возвращать, т.е в ней будет ответ сервера.
3. Задаем настройки для подключения к серверу.
4. Создаем нужный нам json объект.
5. Создаем ещё одну строку, чтобы записать в неё наш json объект, делаем json запрос с этой строкой и возвращаем ответ, если оно надо (помните мы создавали строку flimp). Готово! Рабочий метод, идем тестировать!
Заканчиваем начатое...
Собственно, что тут сказать, тестируем нашу библиотеку, создаем jar файл, подключаем к своим проектам. Profit! Пример полной версии кода - тык.