mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
4.7 KiB
4.7 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash
| description | i18n_source_hash | i18n_provenance | i18n_output_hash |
|---|---|---|---|
| Захват веб-страниц или HTML-фрагментов в виде высококачественных изображений с эмуляцией устройств. | 1e49d070ea2e | human | adbfd040c1ee |
HTML в изображение
Захватывает URL веб-страницы или необработанное HTML-содержимое как изображение-скриншот. Поддерживает эмуляцию устройств (десктоп, планшет, мобильный), захват всей страницы и несколько выходных форматов.
Конечная точка API
POST /api/v1/tools/image/html-to-image
Принимает тело JSON (не multipart). Загрузка файла не требуется.
Параметры
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
| url | string | Условно | - | URL для захвата (должен быть корректным URL) |
| html | string | Условно | - | Необработанное HTML-содержимое для рендеринга (от 1 до 5 000 000 символов) |
| format | string | Нет | "png" |
Выходной формат: jpg, png, webp |
| quality | number | Нет | 90 |
Качество вывода для форматов с потерями (от 1 до 100) |
| fullPage | boolean | Нет | false |
Захватить всю прокручиваемую страницу, а не только область просмотра |
| devicePreset | string | Нет | "desktop" |
Эмуляция устройства: desktop, tablet, mobile, custom |
| viewportWidth | number | Нет | 1280 |
Пользовательская ширина области просмотра в пикселях (от 320 до 3840, используется при devicePreset равном custom) |
| viewportHeight | number | Нет | 720 |
Пользовательская высота области просмотра в пикселях (от 320 до 2160, используется при devicePreset равном custom) |
Должен быть указан либо url, либо html, но не оба сразу.
Пресеты устройств
| Пресет | Ширина | Высота | Мобильный UA |
|---|---|---|---|
desktop |
1280 | 720 | Нет |
tablet |
768 | 1024 | Нет |
mobile |
375 | 812 | Да |
custom |
(задаётся пользователем) | (задаётся пользователем) | Нет |
Пример запроса
Захват веб-страницы:
curl -X POST http://localhost:1349/api/v1/tools/image/html-to-image \
-H "Authorization: Bearer si_your-api-key" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com", "format": "png", "fullPage": true, "devicePreset": "desktop"}'
Рендеринг HTML-содержимого:
curl -X POST http://localhost:1349/api/v1/tools/image/html-to-image \
-H "Authorization: Bearer si_your-api-key" \
-H "Content-Type: application/json" \
-d '{"html": "<div style=\"padding: 20px; background: #f0f0f0;\"><h1>Hello</h1></div>", "format": "png"}'
Пример ответа
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/screenshot.png",
"originalSize": 0,
"processedSize": 145000
}
Примечания
- Требуется установленный на сервере Chromium. Возвращает HTTP 503, если служба браузера недоступна.
- URL проверяются на атаки SSRF (адреса частных/внутренних сетей блокируются).
- Эта конечная точка ограничена 120 запросами в час.
originalSizeвсегда равно 0, поскольку этот инструмент генерирует изображения из URL/HTML.- Имя выходного файла:
screenshot.<format>. - Если страница загружается слишком долго, запрос возвращает HTTP 504 (таймаут шлюза).
- Если служба браузера падает многократно, она временно отключается и возвращает HTTP 503 с кодом
BROWSER_CRASHED.