Использование REST API с Python

Использование REST API с Python

8 декабря 2022 г.

Для запроса данных о физической активности (незавершенных работ) из Terra требуются HTTP-запросы, поэтому я пишу здесь важное руководство по использованию REST API с Python.

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

Чтобы использовать REST API с Python, мы можем использовать модуль requests. Модуль requests — это популярный модуль Python для создания HTTP-запросов. Это позволяет нам отправлять HTTP-запросы и получать ответы от веб-сервера.

Вот пример использования модуля requests для выполнения запроса GET к REST API:

import requests

# Make a GET request to the API endpoint
response = requests.get('https://www.example.com/api/endpoint')

# Check the status code of the response
if response.status_code == 200:
  # If the response is successful (200), read the data from the response
  data = response.json()
  # Print the data
  print(data)
else:
  # If the response is not successful, print the error
  print(response.status_code)

В приведенном выше примере мы отправляем запрос GET к конечной точке API https://www.example.com/api/endpoint и считываем данные ответа в формате JSON. Если ответ успешен (код состояния 200), мы печатаем данные, в противном случае мы печатаем код состояния ошибки.

В дополнение к запросам GET мы также можем использовать модуль requests для выполнения других типов HTTP-запросов, таких как POST, PUT и DELETE. Вот пример того, как сделать запрос POST к API:

import requests

# Set the API endpoint URL
url = 'https://www.example.com/api/endpoint'

# Set the data to be sent in the request
data = {
  'key1': 'value1',
  'key2': 'value2'
}

# Make a POST request to the API endpoint
response = requests.post(url, data=data)

# Check the status code of the response
if response.status_code == 200:
  # If the response is successful (200), read the data from the response
  data = response.json()
  # Print the data
  print(data)
else:
  # If the response is not successful, print the error
  print(response.status_code)

В этом примере мы отправляем запрос POST к конечной точке API по адресу https://www.example.com/api/endpoint с данными {'key1': 'value1', «ключ2»: «значение2». Если ответ успешен, мы печатаем данные.

В противном случае мы печатаем ошибку.


Главное изображение источник.


Оригинал
PREVIOUS ARTICLE
NEXT ARTICLE