📖 Теория: Summary session 7 — Requests

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

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

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

Из лекции: HTTP-запрос состоит из четырёх частей:

• URL — адрес ресурса: http://5.101.50.27:8000/company/list
• Метод — что делать с ресурсом (GET, POST, PATCH, DELETE…)
• Заголовки (Headers) — дополнительные параметры: Content-Type, Authorization, Accept
• Тело (Body) — данные, которые передаются серверу (JSON, форма); у GET-запросов обычно пустое

HTTP-методы (из лекции)

Состав HTTP-ответа

• Статус-код — трёхзначное число: 200 OK, 201 Created, 404 Not Found, 500 Internal Server Error
• Заголовки — Content-Type: application/json и другие
• Тело (Body) — данные от сервера (JSON, HTML); может отсутствовать

Библиотека requests: установка и основы

Из лекции: requests — популярная Python-библиотека для отправки HTTP-запросов. Упрощает работу с API.

# Установка (PowerShell/терминал)
pip install requests

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

# Установка конкретной версии
pip install requests==2.31.0

# Обновление до последней версии
pip install --upgrade requests

Базовые методы

# test_api.py
import requests

BASE_URL = "http://5.101.50.27:8000"

# GET — получение данных
resp = requests.get(BASE_URL + "/company/list")

# POST — создание / авторизация (данные передаём как json=)
resp = requests.post(BASE_URL + "/auth/login", json={"username": "harrypotter", "password": "expelliarmus"})

# PATCH — частичное обновление (с токеном в query-параметре)
resp = requests.patch(BASE_URL + f"/company/update/{company_id}?client_token={token}", json={"name": "New Name"})

# DELETE — удаление
resp = requests.delete(BASE_URL + f"/company/{company_id}?client_token={token}")

Объект Response

Из лекции: каждый метод requests возвращает объект Response с атрибутами:

Работа с JSON в Python

Из лекции: JSON и Python очень похожи, но есть отличия:

# test_json.py
import json

company_json = """
{
    "id": 111,
    "isActive": true,
    "name": "QA Studio"
}
"""

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

XClients API: практика из лекции

Из лекции: XClients — сервис записи на приём к специалистам. Базовый URL: http://5.101.50.27:8000. Модули: auth, company, employee, superuser.

Сценарий из лекции (шаги по порядку)

1. GET /company/list — получить список компаний
2. POST /auth/login — авторизоваться, получить user_token
3. POST /company/create — создать компанию
4. GET /company/list — убедиться, что компания появилась
5. DELETE /company/{id}?client_token=... — удалить компанию
6. GET /company/list — убедиться, что компания исчезла

# test_x_clients.py
import requests

BASE_URL = "http://5.101.50.27:8000"

def test_simple_req():
    resp = requests.get(BASE_URL + "/company/list")
    assert resp.status_code == 200
    assert resp.headers["Content-Type"] == "application/json"
    response_body = resp.json()
    first_company = response_body[0]
    assert first_company["name"] == "QA Студия 'ТестировщикЪ'"

Класс CompanyApi

Из лекции: выносим логику запросов в отдельный класс — тесты становятся чище, API-вызовы переиспользуются, при изменении сервера правим только класс.

# company_api.py
import requests


class CompanyApi:
    """Класс для взаимодействия с API компаний."""

    def __init__(self, url):
        self.url = url

    def get_company_list(self):
        resp = requests.get(self.url + "/company/list")
        assert resp.status_code == 200, f"Ожидался 200, получен {resp.status_code}"
        return resp.json()

    def get_token(self, user, password):
        creds = {"username": user, "password": password}
        resp = requests.post(self.url + "/auth/login", json=creds)
        assert resp.status_code == 200, f"Ожидался 200, получен {resp.status_code}"
        return resp.json()["user_token"]

    def create_company(self, name, description=""):
        company = {"name": name, "description": description}
        resp = requests.post(self.url + "/company/create", json=company)
        assert resp.status_code == 201, f"Ожидался 201, получен {resp.status_code}"
        return resp.json()

    def get_company(self, company_id):
        resp = requests.get(self.url + f"/company/{company_id}")
        assert resp.status_code == 200, f"Ожидался 200, получен {resp.status_code}"
        return resp.json()

    def edit_company(self, company_id, new_name, new_descr):
        token = self.get_token("harrypotter", "expelliarmus")
        url = f"{self.url}/company/update/{company_id}?client_token={token}"
        resp = requests.patch(url, json={"name": new_name, "description": new_descr})
        assert resp.status_code == 200, f"Ожидался 200, получен {resp.status_code}"
        return resp.json()

    def delete_company(self, company_id):
        token = self.get_token("harrypotter", "expelliarmus")
        url = f"{self.url}/company/{company_id}?client_token={token}"
        resp = requests.delete(url)
        assert resp.status_code == 200, f"Ожидался 200, получен {resp.status_code}"
        return resp.json()

Тест с использованием CompanyApi

# test_x_clients.py
from company_api import CompanyApi

BASE_URL = "http://5.101.50.27:8000"


def test_create_company_increases_count():
    """Тест: создание компании увеличивает список на 1."""
    api = CompanyApi(BASE_URL)

    companies_before = api.get_company_list()
    initial_count = len(companies_before)

    api.create_company(name="Test Company", description="Automated test")

    companies_after = api.get_company_list()
    assert len(companies_after) == initial_count + 1

Итог: блок API-тестирования — начало (уроки 13–14)