mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtterandGitHub 4963ab3bbd feat(docs-i18n): translate all documentation into 20 languages

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.

2026-07-11 13:52:47 +08:00

3.4 KiB

Raw Blame History

description, i18n_source_hash, i18n_provenance, i18n_output_hash

description	i18n_source_hash	i18n_provenance	i18n_output_hash
Erfasst Webseiten oder HTML-Snippets als hochwertige Bilder mit Geräteemulation.	1e49d070ea2e	human	b6deed9bc22c

HTML zu Bild

Erfasst eine Webseiten-URL oder rohen HTML-Inhalt als Screenshot-Bild. Unterstützt Geräteemulation (Desktop, Tablet, Mobil), Erfassung der gesamten Seite und mehrere Ausgabeformate.

API-Endpunkt

POST /api/v1/tools/image/html-to-image

Akzeptiert einen JSON-Body (kein Multipart). Es ist kein Datei-Upload erforderlich.

Parameter

Parameter	Typ	Erforderlich	Standard	Beschreibung
url	string	Bedingt	-	Zu erfassende URL (muss eine gültige URL sein)
html	string	Bedingt	-	Zu rendernder roher HTML-Inhalt (1 bis 5.000.000 Zeichen)
format	string	Nein	`"png"`	Ausgabeformat: `jpg`, `png`, `webp`
quality	number	Nein	`90`	Ausgabequalität für verlustbehaftete Formate (1 bis 100)
fullPage	boolean	Nein	`false`	Die gesamte scrollbare Seite erfassen, nicht nur den sichtbaren Bereich
devicePreset	string	Nein	`"desktop"`	Geräteemulation: `desktop`, `tablet`, `mobile`, `custom`
viewportWidth	number	Nein	`1280`	Benutzerdefinierte Viewport-Breite in Pixeln (320 bis 3840, verwendet, wenn devicePreset `custom` ist)
viewportHeight	number	Nein	`720`	Benutzerdefinierte Viewport-Höhe in Pixeln (320 bis 2160, verwendet, wenn devicePreset `custom` ist)

Entweder url oder html muss angegeben werden, aber nicht beides.

Geräte-Voreinstellungen

Voreinstellung	Breite	Höhe	Mobile UA
`desktop`	1280	720	Nein
`tablet`	768	1024	Nein
`mobile`	375	812	Ja
`custom`	(benutzerdefiniert)	(benutzerdefiniert)	Nein

Beispielanfrage

Eine Webseite erfassen:

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-Inhalt rendern:

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"}'

Beispielantwort

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/screenshot.png",
  "originalSize": 0,
  "processedSize": 145000
}

Hinweise

Erfordert, dass Chromium auf dem Server installiert ist. Gibt HTTP 503 zurück, wenn der Browser-Dienst nicht verfügbar ist.
URLs werden gegen SSRF-Angriffe validiert (private/interne Netzwerkadressen werden blockiert).
Dieser Endpunkt ist auf 120 Anfragen pro Stunde begrenzt.
originalSize ist immer 0, da dieses Werkzeug Bilder aus URLs/HTML generiert.
Der Ausgabedateiname lautet screenshot.<format>.
Wenn das Laden der Seite zu lange dauert, gibt die Anfrage HTTP 504 (Gateway-Timeout) zurück.
Wenn der Browser-Dienst wiederholt abstürzt, wird er vorübergehend deaktiviert und gibt HTTP 503 mit dem Code BROWSER_CRASHED zurück.

3.4 KiB Raw Blame History