Python для начинающих

Создание простого API-клиента с requests и json

210 views04:13

Создание простого API‑клиента с requests и json

Рано или поздно каждый питонист сталкивается с задачей: “Нужно что‑то забрать из интернета… программно”. Тут на сцену выходит связка requests + json — минимальный набор, чтобы подружиться с любым более‑менее современным веб‑сервером.

---

### Что такое API и зачем нам клиент?

API — это “договор” о том, как общаться с сервисом: по какому адресу стучаться, какие параметры передавать, в каком формате будет ответ.
Чаще всего ответ приходит в формате JSON — структуре, очень похожей на словари и списки Python.

Наша задача:
1. Отправить HTTP‑запрос (GET, POST, …).
2. Получить ответ.
3. Превратить JSON в привычные объекты Python.

---

### Первый запрос: получаем данные

Установим библиотеку:

pip install requests

Простейший клиент:

import requests

url = "https://jsonplaceholder.typicode.com/posts/1"
response = requests.get(url)

print(response.status_code)  # 200?
print(response.text[:100])   # сырой текст ответа

Но текст — это неудобно. Лучше сразу разобрать JSON:

import json
import requests

url = "https://jsonplaceholder.typicode.com/posts/1"
response = requests.get(url)

if response.status_code == 200:
    data = json.loads(response.text)
    # эквивалентно: data = response.json()
    print(type(data))     # <class 'dict'>
    print(data["title"])  # доступ к полям, как в обычном словаре
else:
    print("Request failed:", response.status_code)

---

### Параметры запроса и мини‑клиент

Обычно API принимает параметры. Например, выбираем несколько постов:

import requests

BASE_URL = "https://jsonplaceholder.typicode.com"

def get_posts(limit=5):
    params = {"_limit": limit}
    response = requests.get(f"{BASE_URL}/posts", params=params)
    response.raise_for_status()  # выбросит исключение при ошибке
    return response.json()

posts = get_posts(limit=3)
for post in posts:
    print(f"{post['id']}: {post['title']}")

Здесь важно:

- params — словарь, который requests превращает в query‑строку (?key=value).
- response.raise_for_status() — простой способ не забыть про обработку ошибок.

---

### Отправка данных: POST с JSON

Иногда нужно не только читать, но и отправлять информацию:

import requests

BASE_URL = "https://jsonplaceholder.typicode.com"

def create_post(title, body, user_id=1):
    payload = {
        "title": title,
        "body": body,
        "userId": user_id,
    }
    response = requests.post(f"{BASE_URL}/posts", json=payload)
    response.raise_for_status()
    return response.json()

new_post = create_post("Hello API", "This is my first API client!")
print(new_post)

Флаг json=payload:

- автоматически превращает словарь в JSON;
- выставляет заголовок Content-Type: application/json.

---

### На что обратить внимание дальше

- Тайм-ауты: requests.get(url, timeout=5)
- Заголовки: headers={"Authorization": "Bearer <token>"}
- Логику удобно оборачивать в класс ApiClient, если эндпоинтов много.

Этой базой уже можно за вечер прикрутить свой скрипт к реальному веб‑сервису: от погоды до телеграм‑ботов — везде вокруг API, а requests + json превращают их в обычные словари и списки Python.

👍2

244 views04:13