Что такое REST API и как получить данные для своего приложения или веб-сайта?

Аббревиатура API обозначает интерфейс прикладного программирования. An API представляет собой набор функций, облегчающих обмен данными между двумя программными приложениями. По сути, API принимает запрос от одного программного приложения к другому, а затем возвращается к исходному программному обеспечению с соответствующим ответом.

ОТДЫХАТЬ означает передачу репрезентативного состояния, и это архитектура, используемая для разработки клиент-серверных приложений. С Rest API, вы получаете представление запрошенных данных, хранящихся в базе данных. А REST API также не имеет состояния, что означает, что сервер не хранит никаких данных между запросами от клиентов.

Если вы ищете Rest API пример и подробное объяснение того, как это работает, продолжайте читать.

Как работает REST API?

А REST API обращается к данным через унифицированные идентификаторы ресурсов (URI), которые представляют собой строку символов, идентифицирующих конкретный ресурс. Тип URI, используемый REST API является унифицированным указателем ресурса (URL).

Для доступа к ресурсам и управления ими REST API использует следующие глаголы запроса:

• Get (используется для получения данных из базы данных)
• Опубликовать (добавить новые данные в базу)
• Положить (обновить данные в базе)
• Удалить (удалить данные из базы данных)

Если вы хотите воспользоваться услугами одного из многих REST API доступный в Интернете (вместо того, чтобы создавать его с нуля), у вас будет доступ только к команде запроса на получение REST API (через URL). Эти URL-адреса состоят из нескольких компонентов, но вам необходимо знать API ключ и запрос.

В API ключ - это уникальный идентификатор, который вы получите после регистрации на REST API Платформа. Запрос обычно представляет собой простое уравнение, используемое для персонализации поиска. Поэтому, если вы хотите узнать текущую погоду в Нью-Йорке, раздел запроса вашего URL-адреса может быть «city = New York».

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

Использование приложения JavaScript для получения данных из разных API-интерфейсов Rest

Чтобы создать это простое приложение, вам необходимо установить на свой компьютер еще два программных приложения: NodeJS и npm. Мы написали статью о том, как установить NodeJS и npm в Ubuntu, а также один на как это сделать в Windows- так что ознакомьтесь с ними, если хотите узнать больше.

После того, как указанные выше приложения будут установлены на ваш компьютер, вам нужно будет выполнить следующие действия:

1. Откройте свою IDE и запустите терминал.
2. Перейдите в папку, содержащую файл вашего приложения JavaScript, с помощью команды cd.
3. Инициализируйте npm следующей строкой кода:

npm init -y

Есть один модуль npm, который будет играть ключевую роль в функциональности этого приложения. Это полученный модуль, представляющий собой библиотеку HTTP-запросов для NodeJS. Следующая строка кода установит последнюю версию полученной библиотеки в файлы вашего приложения:

npm install got @ latest

Теперь вы можете приступить к созданию своего приложения.

Использование библиотеки Got для сборки вашего приложения

// импортируем полученную библиотеку в ваше приложение
const got = require ('got');
// извлекаем данные из определенного REST API и выводим их тело на терминал
(async () => {
пытаться {
const response = ожидание получил (URL);
const data = JSON.parse (response.body);
console.log (данные);
} catch (ошибка) {
console.log (error.data);
}
})();

Приведенное выше приложение будет получать данные из любого REST API В интернете. Однако сначала вам нужно будет указать URL-адрес соответствующего ресурса.

Получение данных из REST API погоды

The Weatherbit.io API одна из самых популярных погодных REST API. Вставка URL-адреса этого API в простое приложение JavaScript, приведенное выше, сделает приложение работоспособным.

Использование REST API Weatherbit.io

// импортируем полученную библиотеку в ваше приложение
const got = require ('got');
// извлекаем данные из определенного REST API и выводим их тело на терминал
(async () => {
пытаться {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
const response = ожидание получил (URL);
const data = JSON.parse (response.body);
console.log (данные);
} catch (ошибка) {
console.log (error.data);
}
})();

URL-адрес Weatherbit.io API теперь успешно вставлен в приложение. Однако есть один аспект URL, который необходимо настроить, чтобы приложение работало. Это раздел под названием «API_KEY», и этот ключ вы получите от Weatherbit.io при регистрации бесплатной учетной записи.

У вас также есть возможность настроить раздел запроса в приведенном выше коде. В настоящее время приложение запрашивает погоду на широте 40,7128 и долготе -74,0060, но вы можете вставить новые координаты. Хотя приведенный выше запрос является рекомендуемым подходом, вы можете искать погоду в месте, используя название города.

Для получения дополнительной информации о том, как использовать Weatherbit.io REST API, кликните сюда.

После вставки API в соответствующем разделе выше, теперь вы можете выполнить свой файл JavaScript. Приложение выдаст в вашем терминале что-то похожее на следующий вывод.

Пример ответа REST API Weatherbit.io

данные: [
{
rh: 53,
pod: 'd',
долг: -74,01,
прес: 1005.9,
часовой пояс: 'Америка / Нью-Йорк',
ob_time: '2021-09-27 14:50',
country_code: 'США',
облака: 25,
ts: 1632754200,
солнечный_рад: 652,8,
state_code: 'Нью-Йорк',
city_name: 'Нью-Йорк',
wind_spd: 5.66,
wind_cdir_full: 'запад-юго-запад',
wind_cdir: 'WSW',
slp: 1015.9,
vis: 5,
h_angle: -30,
закат: '22: 44 ',
dni: 851,72,
роса: 12,
снег: 0,
УФ: 5,68859,
осадков: 0,
wind_dir: 240,
восход: '10: 49 ',
ghi: 657,55,
дхи: 106,79,
аки: 53,
шир: 40,71,
погода: [Объект],
datetime: '2021-09-27: 14',
темп: 22,
станция: 'KJRB',
высота_угол: 40,89,
app_temp: 21.7
}
],
количество: 1
}

Некоторые из наиболее важных аспектов данных, возвращаемых в ответе, включают:

• Название города (возвращает название города с указанными долготой и широтой).
• Дата и время (возвращает текущий час цикла в формате ГГГГ-ММ-ДД: ЧЧ).
• Погода (возвращает объект, содержащий значок погоды, код погоды и текстовое описание погоды).

Получение данных из REST API новостей

Новости API в этом разделе используется Newsdata.io. Как все REST API в Интернете он предоставляет несколько параметров запроса, которые можно использовать для получения последних новостей со всего мира. С Newsdata.io API, вы можете получать новости из определенной страны, определенного языка, категории и т. д.

Используя приложение JavaScript, вы можете получать данные из новостей. REST API. Просто замените URL-адрес в приведенном выше приложении на следующий URL-адрес:

' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '

Следующим шагом будет замена раздела «YOUR_API_KEY» в приведенном выше URL на API ключ, который вы получите после регистрации на Newsdata.io. По указанному выше URL будут возвращены последние новости из Америки. Однако, если вам нужны новости из Японии, вы можете просто заменить запрос «contry = us» на «country = jp».

Для получения дополнительной информации о том, как использовать Newsdata.io REST API, кликните сюда.

Связанный: Хотите добавить заголовки новостей на свой веб-сайт или в приложение? Вам нужен Mediastack API

Newsdata.io Пример ответа REST API

{
title: «Водитель убит дверью собственной машины, когда стоял в очереди в Fast Food Drive-Thru, предоставляя предостережения для самоуправляемых машин с искусственным интеллектом»,
ссылка: ' https://www.forbes.com/sites/lanceeliot/2021/09/27/driver-killed-by-his-own-car-door-while-waiting-in-line-at-fast-food-drive-thru-providing-cautionary-insights-for-ai-self-driving-cars/',
ключевые слова: [Массив],
создатель: [массив],
video_URL: null,
описание: "Печальная новость о водителе, который был убит дверью собственной машины (во время проезда), содержит поучительные сведения о
появление беспилотных автомобилей на основе искусственного интеллекта. Вот взгляд изнутри. ",
содержание: "Печальная новость о водителе, который был убит дверью собственной машины (находясь на проезжей части), содержит предостерегающие выводы о
появление беспилотных автомобилей на основе искусственного интеллекта. Вот взгляд изнутри. ",
pubDate: '2021-09-27 15:30:00',
URL изображения: ' https://thumbor.forbes.com/thumbor/fit-in/0x0/filters%3Aformat%28jpg%29/https://specials-images.forbesimg.com/imageserve/614272b9f18bec6882652695/0x0.jpg? Crop X1 = 23 & Crop X2 = 2455 & Crop Y1 = 23 & Crop Y2 = 1538 ',
source_id: 'forbes'
}

Использование приложения Python для получения данных из разных API-интерфейсов Rest

Можно получать данные для вашего веб-сайта или приложения, используя любой язык программирования, с которым вы знакомы. Итак, если вы не хотите использовать JavaScript, вы можете добиться тех же результатов с помощью приложения Python.

Связанный: Как создавать API на Python: популярные фреймворки

Все, что вам нужно сделать, это установить модуль HTTP запросов python с помощью среды pip. Затем вы можете создать свое приложение Python, используя следующий код:

# импортировать библиотеку запросов
запросы на импорт
# получение данных с помощью библиотеки запросов
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = us '
res = requests.get (URL)
json = res.json ()
для ключа в json:
print (ключ, json [ключ])

Как и в предыдущих примерах, вам нужно будет вставить свой API нажмите в соответствующем разделе. После этого вы получите те же данные, что и приложение JavaScript.

Получить данные для вашего веб-сайта или приложения довольно просто

Теперь у вас есть инструменты, необходимые для сбора данных для ваших программных приложений. Важно помнить, что ОТДЫХАТЬ архитектура облегчает слабую связь, что означает, что вы можете использовать любой язык программирования для получения данных из любого REST API В интернете.

Теперь вы знаете, как пользоваться Rest API, почему бы не попробовать?

Веб-парсинг vs. API: как лучше всего извлекать данные?

Данные есть повсюду, но получить их - другая проблема, даже если это законно.

Читать далее

Об авторе