Ответ
В баг-репорт включаю конкретные данные из Charles, необходимые для воспроизведения и анализа проблемы с API или сетевыми запросами.
Что указывать:
- URL запроса и HTTP-метод (GET, POST и т.д.).
- Заголовки запроса (Request Headers), особенно
Authorization,Content-Type. - Тело запроса (Request Body), если оно есть (JSON, XML).
- Статус код ответа (например,
500 Internal Server Error). - Тело ответа (Response Body) с ошибкой или неверными данными.
- Время отклика для проблем с производительностью.
Пример структурированного баг-репорта:
Заголовок: [API] Получение профиля пользователя возвращает ошибку 500.
Шаги воспроизведения:
1. Выполнить запрос GET /api/v1/profile с валидным токеном.
Ожидаемый результат: Успешный ответ 200 с данными профиля.
Фактический результат: Ошибка 500 Internal Server Error.
Данные из Charles:
=== REQUEST ===
GET https://api.example.com/api/v1/profile HTTP/1.1
Authorization: Bearer eyJhbGciOiJ...
=== RESPONSE ===
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
{
"timestamp": "2023-10-05T12:34:56",
"status": 500,
"error": "Internal Server Error",
"message": "Database connection timeout"
}Важно: Перед вставкой необходимо обфусцировать чувствительные данные (токены, персональные данные).