📖 Теория: Введение в Requests

Работа со словарями в Python

В Python словарь (dict) хранит пары ключ-значение. API-ответы в формате JSON становятся словарями Python. Понимание словарей — основа работы с API.

Создание и доступ к данным

# space_mission — вложенный словарь
space_mission = {
    "Название": "Artemis I",
    "Год запуска": 2022,
    "Страна": "США",
    "Экипаж": None,
    "Оборудование": ["Орион", "Сервисный модуль", "Манекены с датчиками"],
    "Результаты": {
        "Дальность полёта (км)": 432000,
        "Тестирование систем": "Успешно"
    }
}

print(space_mission["Название"])          # Artemis I
print(space_mission["Оборудование"][1])   # Сервисный модуль
print(space_mission["Результаты"]["Дальность полёта (км)"])  # 432000

Основные операции со словарём

Работа с JSON в Python

JSON (JavaScript Object Notation) — текстовый формат обмена данными. Синтаксис похож на Python, но есть отличия:

Разбор JSON через json.loads()

import json

company_json = """
{
    "id": 111,
    "isActive": true,
    "name": "Барбершоп 'Цирюльникъ'",
    "description": "Крутые стрижки для крутых шишек"
}
"""

def test_parse_json():
    company = json.loads(company_json)  # JSON-строка → dict
    assert company["id"] == 111
    assert company["isActive"] is True  # JSON true → Python True

Клиент-серверная архитектура

Клиент — устройство или программа, отправляющая запросы (браузер, мобильное приложение, скрипт Python). Сервер — компьютер, принимающий запросы, обрабатывающий их и возвращающий ответы. Клиентов может быть много, сервер — один.

HTTP и HTTPS

• HTTP (HyperText Transfer Protocol) — протокол передачи гипертекста.
• HTTPS (HTTP Secure) — защищённая версия с шифрованием TLS/SSL. Важна для паролей, банковских данных, любой конфиденциальной информации.

Состав HTTP-запроса

1. URL — адрес ресурса: http://5.101.50.27:8000/company/list
2. Метод — действие над ресурсом (GET, POST, …)
3. Заголовки (Headers) — метаданные: тип контента, авторизация, язык…
4. Тело (Body) — данные, передаваемые серверу (обычно JSON)

HTTP-методы

Заголовки HTTP-запроса

Примеры часто используемых заголовков:

Accept: text/html
Content-Type: application/json; charset=utf-8
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0

• Accept — какой формат данных клиент ожидает в ответе
• Content-Type — формат данных в теле запроса
• Authorization — токен аутентификации
• User-Agent — информация о клиенте

Статус-коды HTTP-ответа

REST API

REST (Representational State Transfer) — набор соглашений по организации API. Ключевые принципы: ресурсы адресуются через URL, действия — через HTTP-методы, обмен данными — через JSON или XML.

Пример REST-операций над ресурсом /company:

Библиотека requests

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

Установка

# Установить последнюю версию
pip install requests

# Проверить установку
pip show requests

# Установить конкретную версию
pip install requests==2.32.3

# Обновить
pip install --upgrade requests

Объект Response

Каждый запрос возвращает объект Response с атрибутами:

resp.text vs resp.json()

Сессии (Session)

Объект requests.Session переиспользует TCP-соединение и автоматически передаёт куки между запросами. Это ускоряет работу при нескольких запросах к одному серверу.

# api_client.py
import requests

with requests.Session() as session:
    session.headers.update({"Authorization": "Bearer my-token"})
    resp1 = session.get("https://api.example.com/users")
    resp2 = session.get("https://api.example.com/companies")
    # Куки и заголовки автоматически переиспользуются

Сервис X-Clients

В этом уроке мы работаем с реальным тестовым API — X-Clients (сервис записи на приём к специалистам). Базовый URL: http://5.101.50.27:8000

Модули сервиса

Паттерн API-клиента: класс CompanyApi

Вместо дублирования вызовов requests.get() в каждом тесте лучше создать класс, инкапсулирующий работу с API. Это ключевой паттерн для поддерживаемых API-тестов.

Преимущества:

• Нет дублирования кода — URL, заголовки, обработка ошибок в одном месте
• Тесты читаются как документация: api.get_company_list()
• При изменении API — меняем только класс, не все тесты
• Лёгкое переиспользование в разных тест-файлах