APIScribe: панель DevTools для записанных доказательств API и экспорта
APIScribe, разработанный Адитьей Нандедкаром, является расширением Chrome, которое захватывает взаимодействия API для документации и отладки внутри DevTools. Расширение записывает вызовы XHR и Fetch в реальном времени и захватывает конечную точку, HTTP-метод, полезные нагрузки, коды состояния и время для структурированных журналов. Оно предлагает управление сессиями, экспорт в Markdown и простой текст, а также настраиваемые предпочтения захвата. Разработчики фронтенда и инженеры по контролю качества получают локальный рабочий процесс, который сохраняет конфиденциальные данные API на их машине.
Как APIScribe записывает трафик API в DevTools?
Установленный как отдельная панель DevTools, которая появляется рядом с Elements, Console и Network, расширение в реальном времени транслирует запросы XHR и Fetch и отображает записи с URL, HTTP-методом, полезной нагрузкой запроса, статусом ответа и метаданными времени. Панель отделяет вызовы API от общего сетевого шума и форматирует каждую запись так, чтобы она могла служить судебными доказательствами во время воспроизведений и отчетов об ошибках.
Насколько детальны элементы управления сессией и варианты экспорта?
Запись сессий использует Start, Pause, Resume и Stop элементы управления, так что захваты сохраняются между прерванными тестами без потери собранных записей. Настройки позволяют пользователям переключать включение заголовков, тел ответов и значений задержки перед экспортом. Экспорты создают структурированные файлы Markdown (.md) или Plain Text (.txt), отформатированные для удобочитаемых доказательств и быстрого вставления в трекеры проблем или документацию, что подходит для рабочих процессов, требующих готовых к копированию журналов.
Сохраняет ли APIScribe захваченные данные API локально и где синхронизируются настройки?
Расширение обрабатывает захваченный трафик API на локальном компьютере и не использует учетные записи, облачное хранилище или внешнюю аналитику, отражая только локальный дизайн. Предпочтения захвата синхронизируются с профилем Chrome пользователя, так что настройки перемещаются с вошедшим в систему профилем, в то время как записанные данные остаются на устройстве до явной загрузки. Расширение нацелено на Chrome на настольных платформах, а не действует как системный прокси.
APIScribe — это специализированное средство для сбора доказательств API в браузере
APIScribe — это практичный вариант для разработчиков и специалистов по контролю качества, которые полагаются на отладку в браузере и хотят быстро получить готовые к документированию журналы API. Его узкая направленность предпочитает захваты в контексте и структурированные экспорты широким сетевым судебно-медицинским исследованиям, поэтому командам, которым необходимо захватывать трафик по всей системе, следует использовать его вместе с другими инструментами. Для рабочих процессов отчетности, сосредоточенных на инструментах разработчика, он снижает трение и удобно вписывается в существующие процессы на основе браузера. Принятие простое.
