Для какого функционала делать API тест-кейс

1️⃣ Как кратко ответить

API тест-кейсы создаются для проверки функциональности, производительности, безопасности и надежности API. Они охватывают сценарии, такие как проверка корректности ответов на запросы, обработка ошибок, тестирование граничных условий, аутентификация и авторизация, а также нагрузочное тестирование.

2️⃣ Подробное объяснение темы

API (Application Programming Interface) — это интерфейс, который позволяет различным программным компонентам взаимодействовать друг с другом. Тестирование API важно для обеспечения корректной работы приложения, так как API часто служат связующим звеном между различными системами и компонентами.

Зачем нужны API тест-кейсы:

1. Проверка функциональности: Убедиться, что API выполняет свои функции согласно спецификации. Например, если API должен возвращать список пользователей, тест-кейс проверит, что запрос действительно возвращает корректный список.

2. Обработка ошибок: Проверка, как API обрабатывает некорректные запросы или данные. Например, если API ожидает числовое значение, тест-кейс может отправить строку и проверить, что возвращается соответствующая ошибка.

3. Тестирование граничных условий: Проверка, как API ведет себя при крайних значениях входных данных. Например, если API принимает число от 1 до 100, тест-кейс может проверить поведение при значениях 0 и 101.

4. Аутентификация и авторизация: Убедиться, что доступ к API защищен и что только авторизованные пользователи могут выполнять определенные действия. Например, тест-кейс может проверить, что без токена доступа API возвращает ошибку.

5. Производительность и нагрузка: Оценка, как API справляется с большим количеством запросов. Например, тест-кейс может отправить 1000 запросов в секунду и проверить, что API продолжает работать стабильно.

Пример тест-кейса для API:

Рассмотрим пример тест-кейса для API, который возвращает информацию о пользователе по его ID.

import requests
​
# URL API
url = "https://api.example.com/users/"
​
# Тест-кейс: Проверка получения информации о пользователе по ID
def test_get_user_by_id():
    # ID пользователя, которого мы хотим получить
    user_id = 123
​
    # Отправка GET-запроса к API
    response = requests.get(url + str(user_id))
​
    # Проверка, что статус-код ответа 200 (OK)
    assert response.status_code == 200, "Expected status code 200, got {}".format(response.status_code)
​
    # Проверка, что в ответе содержится информация о пользователе
    user_data = response.json()
    assert 'id' in user_data, "Response JSON does not contain 'id'"
    assert user_data['id'] == user_id, "User ID in response does not match requested ID"
​
# Запуск тест-кейса
test_get_user_by_id()

Комментарии к коду:

• import requests: Импортируем библиотеку requests для отправки HTTP-запросов.
• url = "https://api.example.com/users/": Определяем базовый URL для API.
• def test_get_user_by_id(): Определяем функцию тест-кейса для проверки получения информации о пользователе.
• user_id = 123: Указываем ID пользователя, информацию о котором хотим получить.
• response = requests.get(url + str(user_id)): Отправляем GET-запрос к API с указанным ID пользователя.
• assert response.status_code == 200: Проверяем, что API возвращает статус-код 200, что означает успешное выполнение запроса.
• user_data = response.json(): Преобразуем ответ API в формат JSON для дальнейшей проверки.
• assert 'id' in user_data: Проверяем, что в ответе содержится поле 'id'.
• assert user_data['id'] == user_id: Проверяем, что ID пользователя в ответе совпадает с запрашиваемым ID.

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