🔁 Автотесты на API
API-автотесты проверяют бэкенд без браузера: тест шлёт HTTP-запрос, смотрит код, тело и заголовки и за секунды узнаёт, сломался ли заказ, оплата или промокод. На уровне API их легче всего писать и поддерживать, поэтому с них часто начинают автоматизацию в команде. От мидла здесь ждут инженерной части: как разложен проект, где живёт токен, кто убирает за тестом и что делать, если соседний сервис лежит
🧠 Как устроен проект
Проект держится на четырёх слоях. Смена адреса стенда или формата токена правится в одном месте, а не в двухстах тестах
| Слой | Что в нём | Чего в нём нет |
|---|---|---|
Клиент (shop_api/client.py) | Базовый URL, сессия, заголовки, таймаут, по методу на эндпоинт | Проверок и assert |
Модели (shop_api/models.py) | Схема ответа на pydantic | Логики запросов |
Фикстуры (conftest.py) | Логин, создание и удаление данных | Проверок бизнес-правил |
Тесты (tests/) | Шаг, проверка кода, тела и правила | URL, токенов и паролей |
Клиент тонкий: он возвращает ответ как есть и ничего не решает за тест. Если клиент сам бросает исключение на 400, негативный тест на неверный промокод придётся писать через pytest.raises, и тест перестанет показывать, что именно ответил сервер. Исключение — логин: без токена дальше идти незачем
Адрес стенда и учётка приходят из переменных окружения API_URL, QA_LOGIN, QA_PASSWORD: набор гоняется и на dev, и на stage, а пароль не попадает в Git
requests или httpx
Обе библиотеки решают одну задачу, интерфейс похож: requests.Session в httpx называется httpx.Client, аргументы переносятся почти один в один. Разница в поведении по умолчанию, и на ней ловят на собеседовании
| requests 2.34 | httpx 0.28 | |
|---|---|---|
| Таймаут по умолчанию | Нет: без timeout= запрос ждёт сколько угодно | 5 секунд бездействия сети |
| Редиректы | Идёт по ним сам | Не идёт, нужен follow_redirects=True |
| async | Нет | httpx.AsyncClient |
| HTTP/2 | Нет | Есть, pip install httpx[http2] и http2=True |
| Мок в тестах | responses | respx |
Для обычного набора тестов берут то, что уже стоит в проекте, а httpx — когда нужен HTTP/2 или сотни параллельных запросов через asyncio. Стабильная версия httpx до сих пор 0.28.1 от декабря 2024, 1.0 выходит только dev-сборками, так что версию в зависимостях фиксируй
🛠️ Клиент, токен и первый тест
Клиент хранит requests.Session: в ней живут заголовок с токеном и пул соединений, и каждый следующий запрос к тому же хосту не открывает TCP заново
Python · Тонкий клиент над API магазина
import requests
class ShopClient:
"""Тонкий клиент: URL, сессия и заголовки. Проверок тут нет"""
def __init__(self, base_url: str, timeout: float = 5):
self.base_url = base_url.rstrip("/")
self.timeout = timeout
self.session = requests.Session()
def login(self, login: str, password: str) -> None:
r = self.session.post(f"{self.base_url}/auth/token",
json={"login": login, "password": password}, timeout=self.timeout)
r.raise_for_status() # без токена дальше идти нет смысла
self.session.headers["Authorization"] = f"Bearer {r.json()['access_token']}"
def create_order(self, items: list[dict], promo_code: str | None = None) -> requests.Response:
return self.session.post(f"{self.base_url}/orders",
json={"items": items, "promo_code": promo_code}, timeout=self.timeout)
def get_order(self, order_id: int) -> requests.Response:
return self.session.get(f"{self.base_url}/orders/{order_id}", timeout=self.timeout)
def delete_order(self, order_id: int) -> requests.Response:
return self.session.delete(f"{self.base_url}/orders/{order_id}", timeout=self.timeout)Логин делается один раз на весь прогон через фикстуру со scope="session". Если логиниться в каждом тесте, 300 тестов дадут 300 запросов на /auth/token, и на стенде с лимитом на авторизацию часть из них получит 429. Заказ, наоборот, у каждого теста свой: фикстура order создаёт его до теста и удаляет после yield
import os
import pytest
from shop_api.client import ShopClient
@pytest.fixture(scope="session")
def api() -> ShopClient:
# Логин один раз на весь прогон: токен живёт в заголовках сессии
client = ShopClient(os.environ.get("API_URL", "https://api.shop.example.com"))
client.login(os.environ["QA_LOGIN"], os.environ["QA_PASSWORD"])
return client
@pytest.fixture
def order(api):
r = api.create_order([{"sku": "MUG-01", "qty": 2}], promo_code="SALE10")
assert r.status_code == 201, r.text # упала подготовка, а не проверка
created = r.json()
yield created
api.delete_order(created["id"]) # чистим, даже если тест упалДве кружки по 1000 ₽ с промокодом SALE10 должны стоить 1800 ₽
from decimal import Decimal
from shop_api.models import Order
def test_order_has_valid_schema(api, order):
r = api.get_order(order["id"])
assert r.status_code == 200
assert r.headers["Content-Type"].startswith("application/json")
got = Order.model_validate(r.json())
assert got.status == "new"
def test_sale10_gives_10_percent(api, order):
got = Order.model_validate(api.get_order(order["id"]).json())
assert got.total == Decimal("1800.00")
def test_order_without_token_is_401(api, order):
# None убирает заголовок сессии только для этого запроса
r = api.session.get(f"{api.base_url}/orders/{order['id']}",
headers={"Authorization": None})
assert r.status_code == 401Прогон против локальной заглушки API на http.server (Python 3.13, pytest 9.2.0, requests 2.34.2) и журнал заглушки:
$ API_URL=http://127.0.0.1:8765 QA_LOGIN=qa QA_PASSWORD=*** pytest -v
tests/test_orders.py::test_order_has_valid_schema PASSED [ 33%]
tests/test_orders.py::test_sale10_gives_10_percent PASSED [ 66%]
tests/test_orders.py::test_order_without_token_is_401 PASSED [100%]
============================== 3 passed in 0.34s ===============================
--- журнал заглушки
TOKEN REQUEST
CREATE 1001
DELETE 1001
CREATE 1002
DELETE 1002
CREATE 1003
DELETE 1003Токен запрошен один раз, а каждый тест получил свой заказ и убрал его за собой. Какие кейсы на заказ автоматизировать, разобрано на странице «Как тестировать REST API», а механизм фикстур — на странице «pytest»
📐 Как проверить схему ответа
Проверка «код 200 и есть поле id» пропускает большую часть багов формата. Модель pydantic v2 и model_validate одной строкой проверяют все поля, типы и вложенные объекты
from datetime import datetime
from decimal import Decimal
from typing import Literal
from pydantic import BaseModel, ConfigDict, Field
class Item(BaseModel):
sku: str
qty: int = Field(ge=1)
class Order(BaseModel):
model_config = ConfigDict(extra="forbid", strict=True) # лишнее поле или "1001" вместо 1001 — ошибка
id: int
status: Literal["new", "paid", "cancelled"]
items: list[Item]
total: Decimal = Field(strict=False) # деньги приходят строкой "1800.00"
created_at: datetime = Field(strict=False)На ответе со строковым id, опечаткой в статусе, нулевым количеством, датой «вчера» и лишним полем pydantic 2.14.3 перечислил все пять ошибок сразу, с путём до поля (строки со ссылками на errors.pydantic.dev убраны):
5 validation errors for Order
id
Input should be a valid integer [type=int_type, input_value='1001', input_type=str]
status
Input should be 'new', 'paid' or 'cancelled' [type=literal_error, input_value='payed', input_type=str]
items.0.qty
Input should be greater than or equal to 1 [type=greater_than_equal, input_value=0, input_type=int]
created_at
Input should be a valid datetime or date, invalid character in year [type=datetime_from_date_parsing, input_value='вчера', input_type=str]
discount
Extra inputs are not permitted [type=extra_forbidden, input_value=200, input_type=int]Две настройки здесь главные. По умолчанию pydantic работает в нестрогом режиме и молча приводит типы: {"id": "1001", "paid": "yes"} превращается в id=1001 paid=True, и тест зелёный, хотя фронтенд на строке может сломаться. strict=True в model_config это запрещает, а Field(strict=False) точечно разрешает приведение там, где строка ожидаема, как у суммы и даты. Вторая настройка: без extra="forbid" лишние поля просто отбрасываются, и утечка password_hash в ответе пройдёт незамеченной
Если схема уже есть в виде JSON Schema или OpenAPI, переписывать её в модели незачем: в тесте вызывают jsonschema с Draft202012Validator. Как устроена сама схема и почему format по умолчанию не проверяется, разобрано на странице «JSON, схемы и контракты»
🧹 Подготовка и очистка данных
Данные для теста готовят через API, а не через UI и не руками на стенде. Заказ запросом создаётся за 50 миллисекунд, через интерфейс за 10 секунд, и у теста появляется лишний повод упасть по чужой причине. Если нужного эндпоинта нет, данные вставляют SQL-запросом в тестовую базу: как это делать и проверять, разобрано на странице «Проверка данных после API»
Правила, которые держат стенд чистым:
- очистка в фикстуре после
yield, а не последней строкой теста. Строка после упавшегоassertне выполнится, а код послеyieldpytest вызовет и при падении теста - уникальные значения в каждом прогоне: email вида
qa+{uuid4().hex[:8]}@shop.example.com, а неtest@test.ru. Иначе второй прогон упадёт на «пользователь уже существует», а два параллельных прогона будут удалять данные друг друга - удаляешь только то, что создал сам, по
idиз ответа. Чистка «всех заказов пользователя qa» сотрёт данные соседнего прогона
Когда DELETE в API нет (заказы часто только отменяют), убирают по-другому: переводят в cancelled, помечают тестовые сущности префиксом и чистят их ночным скриптом
🔌 Когда внешний сервис недоступен
Магазин ходит в службу доставки и платёжный шлюз, а на стенде их часто нет или они берут деньги за вызов. Чем их подменить, зависит от того, где выполняется код, который туда ходит
responses и respx подменяют HTTP только внутри процесса Python, в котором запущен тест. Это компонентные тесты бэкенда на Python и тесты своего клиента. Функция ниже считает цену доставки и должна пережить падение службы
import requests
import responses
from delivery import DELIVERY_URL, delivery_price
@responses.activate
def test_price_from_delivery_service():
responses.get(DELIVERY_URL, json={"price": 350})
assert delivery_price("Казань") == 350
assert responses.calls[0].request.params == {"city": "Казань"}
@responses.activate
def test_delivery_returns_503():
responses.get(DELIVERY_URL, status=503)
assert delivery_price("Казань") is None
@responses.activate
def test_delivery_is_down():
# исключение вместо тела — как будто сервер не ответил вовсе
responses.get(DELIVERY_URL, body=requests.ConnectionError("connection refused"))
assert delivery_price("Казань") is NoneТот же сценарий для httpx через respx, с фикстурой respx_mock, которую библиотека добавляет в pytest сама:
import httpx
import respx
from delivery_httpx import DELIVERY_URL, delivery_price
@respx.mock
def test_delivery_timeout():
respx.get(DELIVERY_URL).mock(side_effect=httpx.ConnectTimeout("timeout"))
assert delivery_price("Казань") is None
def test_price_with_fixture(respx_mock):
route = respx_mock.get(DELIVERY_URL, params={"city": "Казань"}).respond(json={"price": 350})
assert delivery_price("Казань") == 350
assert route.called$ pytest -v
test_delivery.py::test_price_from_delivery_service PASSED [ 20%]
test_delivery.py::test_delivery_returns_503 PASSED [ 40%]
test_delivery.py::test_delivery_is_down PASSED [ 60%]
test_delivery_httpx.py::test_delivery_timeout PASSED [ 80%]
test_delivery_httpx.py::test_price_with_fixture PASSED [100%]
============================== 5 passed in 0.32s ===============================Незарегистрированный адрес responses в сеть не пустит и бросит ConnectionError со списком моков. respx строже: по умолчанию тест падает и на незамоканном запросе, и на моке, который не вызвали. У @responses.activate вторая проверка выключена (assert_all_requests_are_fired=False)
Когда тесты ходят в развёрнутый сервис по сети, responses бесполезен: бэкенд работает в другом процессе и на другой машине. Тут нужна заглушка-сервер. Самая известная — WireMock: запускается Docker-образом wiremock/wiremock на порту 8080, ответы описываются JSON-файлами в /home/wiremock/mappings или через /__admin/mappings. В конфиге стенда адрес службы доставки меняют на WireMock, и тест сам решает, что она ответит: 350 ₽, 503 или тишину на 30 секунд
🐳 Testcontainers: зависимость в контейнере на время теста
Когда тесту нужна настоящая база, Kafka или Redis без чужих данных, Testcontainers поднимает её в Docker перед тестом и удаляет после. Библиотеки есть для Java, Go, .NET, Node.js, Python, Rust, Ruby, PHP и других языков. Для Python ставится pip install "testcontainers[postgres]" плюс драйвер базы отдельно, например psycopg[binary]
import psycopg
import pytest
from testcontainers.community.postgres import PostgresContainer
@pytest.fixture(scope="session")
def db_url():
# Чистый Postgres на случайном порту, после прогона контейнер удаляется
with PostgresContainer("postgres:16-alpine", driver=None) as pg:
yield pg.get_connection_url()
@pytest.fixture
def conn(db_url):
with psycopg.connect(db_url) as c:
c.execute("CREATE TABLE IF NOT EXISTS promo (code text PRIMARY KEY, percent int)")
c.execute("INSERT INTO promo VALUES ('SALE10', 10)")
yield c
c.rollback() # данные теста не переживают тест
def test_sale10_is_10_percent(conn):
percent = conn.execute("SELECT percent FROM promo WHERE code = 'SALE10'").fetchone()[0]
assert 2000 * (100 - percent) // 100 == 1800С testcontainers 4.15.0 и уже скачанным образом тест прошёл за 1,6 секунды. Старый импорт from testcontainers.postgres ещё работает, но выдаёт DeprecationWarning с советом перейти на testcontainers.community.postgres. driver=None нужен для psycopg 3: без него строка подключения получается в формате SQLAlchemy с +psycopg2
Контейнер стартует один раз на сессию, а изоляцию между тестами даёт откат транзакции. Цена: нужен Docker, а первый прогон тянет образ. Рядом стартует служебный контейнер Ryuk, который подчищает забытое, даже если тесты упали. В CI без доступа к Docker Hub его образ кладут в свой реестр или отключают через TESTCONTAINERS_RYUK_DISABLED=true
⚠️ Где ошибаются
- Запросы без таймаута на requests. Стенд завис, и прогон висит до лимита джоба в CI без строчки в отчёте. Таймаут ставят в клиенте один раз
- Логин в каждом тесте. Прогон медленнее, стенд отвечает 429, и тесты падают «случайно». Токен получают в фикстуре со
scope="session", а если он живёт 15 минут, клиент перелогинивается по 401 - Нестрогая модель pydantic как проверка схемы. Без
strict=Trueиextra="forbid"модель принимает"1001"вместо числа и отбрасывает лишние поля. Тест зелёный, контракт сломан - Очистка в конце теста. Каждый упавший
assertоставляет заказ на стенде, и через месяц их там тысячи. Удаление — только послеyieldв фикстуре responsesпротив удалённого бэкенда. Мок наdelivery.example.comв тесте никак не влияет на сервер на stage, и тест проверяет настоящую службу доставки. Для сервиса за сетью нужен WireMock или аналог, подключённый в конфиге стенда
🎯 Вопросы с собеседований
Как ты устроишь проект API-автотестов с нуля?
Четыре слоя: тонкий клиент над API с методом на каждый эндпоинт, модели ответов на pydantic, фикстуры в conftest.py и сами тесты. Клиент знает URL, сессию, заголовки и таймаут, но ничего не проверяет. Логин делаю фикстурой со scope="session", адрес стенда и учётку беру из переменных окружения. Данные каждый тест создаёт себе сам через API и удаляет в фикстуре после yield
Как проверить, что ответ API соответствует схеме?
Описываю ответ моделью pydantic v2 и вызываю Model.model_validate(r.json()): она проверит типы, обязательные поля, вложенные объекты и перечислит все ошибки с путём до поля. Включаю strict=True, иначе строка "1001" молча станет числом, и extra="forbid", чтобы ловить лишние поля. Если у бэкенда уже есть JSON Schema или OpenAPI, проверяю библиотекой jsonschema, чтобы схема была одна на всех
Как ты готовишь тестовые данные и как убираешь их после теста?
Готовлю через API, а если эндпоинта нет, вставляю в тестовую базу SQL-запросом. Создание и удаление живут в одной фикстуре: до yield создаю, после удаляю по id из ответа, и это выполнится даже при упавшем тесте. Значения делаю уникальными на каждый прогон, чтобы параллельные запуски не мешали друг другу. Где удаления нет, перевожу сущность в конечный статус и помечаю префиксом для ночной чистки
Как тестировать, если внешний сервис недоступен?
Подменяю его. Если код, который ходит во внешний сервис, выполняется в процессе теста, мокаю HTTP библиотекой responses для requests или respx для httpx и проверяю три ответа: нормальный, 5xx и обрыв соединения. Если тестирую развёрнутый бэкенд по сети, поднимаю заглушку-сервер вроде WireMock и в конфиге стенда меняю адрес сервиса на неё
Чем requests отличается от httpx и что ты выберешь?
Интерфейс почти одинаковый, requests.Session соответствует httpx.Client. httpx умеет async и HTTP/2, по умолчанию ставит таймаут 5 секунд и не идёт по редиректам, а requests без явного timeout ждёт бесконечно и по редиректам идёт. Для обычного набора API-тестов беру то, что уже есть в проекте, httpx — если нужен async или HTTP/2
Тест поднимает Postgres в Testcontainers. Как не тратить на это минуту на каждый тест?
Контейнер выношу в фикстуру со scope="session": он стартует один раз на прогон. Изоляцию между тестами даю откатом транзакции или очисткой таблиц в фикстуре с scope="function". Образ в CI держу в своём реестре
📚 Что почитать
- requests: Advanced Usage — сессии, таймауты и повторы через
urllib3.util.Retryв официальной документации - HTTPX: Requests Compatibility — все отличия httpx от requests на одной странице
- Pydantic: Strict Mode — какие приведения типов делает нестрогий режим и как включить строгий на модель, поле или вызов
- RESPX: Guide — маршруты,
side_effectи проверкиassert_all_mockedиassert_all_called - Testcontainers for Python — установка модулей через extras и пример с Postgres