В современном мире API стали неотъемлемой частью современной веб-разработки. Они позволяют приложениям взаимодействовать друг с другом, обмениваться данными и предоставляют мощные функциональные возможности. REST API, в частности, стали популярным способом создания API, использующих протокол HTTP. В этом сообщении блога мы узнаем, как вызывать REST API с помощью JavaScript в Node.js.
Что такое REST API?
Прежде чем мы углубимся в то, как вызывать REST API с помощью JavaScript в Node.js, давайте сначала разберемся, что такое REST API. REST расшифровывается как Representational State Transfer, стиль архитектуры программного обеспечения, который определяет набор ограничений, которые будут использоваться для создания веб-сервисов. RESTful API — это интерфейс прикладной программы (API), который использует HTTP-запросы для GET, PUT, POST и DELETE данных.
Основные характеристики REST API:
- Клиент-серверная архитектура
- Безгражданство
- Кэшируемость
- Многоуровневая система
- Код по запросу
- Единый интерфейс
Теперь, когда мы лучше понимаем, что такое REST API, давайте узнаем, как вызывать его с помощью JavaScript в Node.js.
Вызов REST API с помощью JavaScript в Node.js
Node.js — это популярная среда выполнения JavaScript, которая позволяет разработчикам запускать JavaScript на стороне сервера. Чтобы вызвать REST API с помощью JavaScript в Node.js, мы можем использовать встроенный модуль http или стороннюю библиотеку, например axios, request или node-fetch.
В этом сообщении блога мы будем использовать библиотеку axios для вызова REST API. axios — популярный HTTP-клиент для JavaScript, поддерживающий запросы и ответы на основе Promise.
Шаг 1: Установите Axios
Первый шаг — установить библиотеку axios с помощью npm. Откройте окно терминала и выполните следующую команду:
npm установить аксиомы
Шаг 2: Импортируйте аксиомы
После установки axios нам нужно импортировать его в наше приложение Node.js. Откройте файл JavaScript и добавьте следующий код:
const axios = require(‘axios’);
Это импортирует библиотеку axios и сделает ее доступной для использования в нашем коде.
Шаг 3. Сделайте запрос GET.
Теперь, когда мы импортировали axios, мы можем использовать его для выполнения запроса GET к REST API. Предположим, что мы хотим получить список пользователей из конечной точки API по адресу https://jsonplaceholder.typicode.com/users. Мы можем сделать запрос GET к этой конечной точке, используя следующий код:
axios.get('https://jsonplaceholder.typicode.com/users')
.then(response =› {
console.log(response.data);
})
.catch(error =› {
console.log(error);
});
Этот код использует метод axios.get для выполнения запроса GET к указанной конечной точке API. Когда запрос выполнен успешно, данные ответа записываются в консоль. Если есть ошибка, ошибка регистрируется в консоли.
Шаг 4: Сделайте POST-запрос
Помимо выполнения запросов GET, мы также можем использовать axios его для выполнения запросов POST. Предположим, что мы хотим создать нового пользователя, отправив запрос POST в ту же конечную точку API по адресу https://jsonplaceholder.typicode.com/users. Мы можем сделать POST-запрос к этой конечной точке, используя следующий код:
axios.post('https://jsonplaceholder.typicode.com/users', {
name: 'John Doe',
email: '[email protected]'
})
.then(response =› {
console.log(response.data);
})
.catch(error =› {
console.log(ошибка);
});
Этот код использует метод axios.post для выполнения запроса POST к указанной конечной точке API. Мы передаем объект, содержащий данные, которые мы хотим отправить, в качестве второго параметра методу axios.post. Когда запрос выполнен успешно, данные ответа записываются в консоль. Если есть ошибка, ошибка регистрируется в консоли.
Шаг 5: Добавьте заголовки и параметры запроса
В некоторых случаях нам может потребоваться добавить заголовки или параметры запроса к нашим запросам API. axios позволяет нам легко добавлять заголовки и параметры запроса, используя параметры headers и params.
Предположим, что мы хотим получить список пользователей с определенным идентификатором из той же конечной точки API по адресу https://jsonplaceholder.typicode.com/users. Мы можем сделать запрос GET с параметром запроса для идентификатора пользователя, используя следующий код:
axios.get('https://jsonplaceholder.typicode.com/users', {
params: {
id: 1
}
})< br /> .then(response =› {
console.log(response.data);
})
.catch(error =› {
console.log(error) ;
});
Этот код использует параметр params для добавления параметра запроса для идентификатора пользователя в наш запрос GET. Когда запрос выполнен успешно, данные ответа записываются в консоль. Если есть ошибка, ошибка регистрируется в консоли.
Мы также можем добавлять заголовки к нашим запросам API, используя параметр headers. Предположим, что мы хотим отправить токен авторизации с нашим POST-запросом на ту же конечную точку API по адресу https://jsonplaceholder.typicode.com/users. Мы можем сделать запрос POST с заголовком авторизации, используя следующий код:
axios.post('https://jsonplaceholder.typicode.com/users', {
name: 'John Doe',
email: '[email protected]'
}, {
заголовки: {
Авторизация: 'Bearer mytoken'
}
})
.then(response =› {
console.log(response.data);
})
.catch(error =› {
console.log(error);
});
Этот код использует параметр headers для добавления заголовка авторизации в наш POST-запрос. Когда запрос выполнен успешно, данные ответа записываются в консоль. Если есть ошибка, ошибка регистрируется в консоли.
Заключение
В этом сообщении блога мы узнали, как вызывать REST API с помощью JavaScript в Node.js с помощью библиотеки axios. Мы рассмотрели, как делать запросы GET и POST, добавлять заголовки и параметры запроса и обрабатывать ошибки. Используя его, мы можем легко интегрироваться с RESTful API и получать или отправлять данные во внешние службы.
