Open-Graph-Bilder erzeugen mit Java

Was Sie brauchen

• Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
• Java. Sie brauchen Java 17 oder neuer; java.net.http.HttpClient und Textblöcke gehören zum JDK.
• Die Vorlage. og-image aus dem Open-Graph-Beispiel: Tailwind-Klassen, beim Rendern kompiliert, kein Stylesheet zu pflegen.
• Die Daten. Die data.json des Beispiels neben dem Programm: Kategorie, Titel, Veröffentlichungsdatum, Lesedauer und der Autor mit Avatar-URL.

Das Programm

Das Programm liest data.json, fordert png an, macht die Ausgabe öffentlich, wartet auf das Ergebnis, wenn die API mit 202 antwortet, und speichert das Bild; download_url ist seine Adresse auf dem CDN.

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class Render {
  static final String ENDPOINT = "https://api-eu.formfeed.dev/v1/renders";
  static final HttpClient CLIENT = HttpClient.newHttpClient();

  public static void main(String[] args) throws Exception {
    String data = Files.readString(Path.of("data.json"));

    // the JDK has no JSON library: the body is a text block, and a project would use Jackson or Gson
    String body = """
        {
          "template": "og-image",
          "data": %s,
          "output": "png",
          "access": "public"
        }
        """.formatted(data);

    HttpResponse<String> response = send(HttpRequest.newBuilder(URI.create(ENDPOINT)).POST(HttpRequest.BodyPublishers.ofString(body)));

    // not done within 60 seconds: the answer is 202 and the render goes on in the background;
    // its result answers the same way until the render has finished
    while (response.statusCode() == 202) {
      Thread.sleep(2000);
      response = send(HttpRequest.newBuilder(URI.create(ENDPOINT + "/" + field(response.body(), "id") + "/result")));
    }

    // every error is a problem document (RFC 9457) with a title and a detail
    if (response.statusCode() >= 400) {
      System.err.println(response.body());
      System.exit(1);
    }

    String render = response.body();
    CLIENT.send(HttpRequest.newBuilder(URI.create(field(render, "download_url"))).build(),
        HttpResponse.BodyHandlers.ofFile(Path.of("og-image.png")));
    System.out.println(field(render, "id") + " " + field(render, "download_url"));
  }

  /** One call to the API with the key; the download goes to a signed URL without it. */
  static HttpResponse<String> send(HttpRequest.Builder request) throws Exception {
    return CLIENT.send(request
        .header("Authorization", "Bearer " + System.getenv("FORMFEED_API_KEY"))
        .header("Content-Type", "application/json")
        .build(), HttpResponse.BodyHandlers.ofString());
  }

  /** The first value of a field anywhere in a JSON text; a project would use Jackson or Gson instead. */
  static String field(String json, String name) {
    Matcher m = Pattern.compile("\"" + name + "\"\\s*:\\s*(?:\"([^\"]*)\"|([^,}\\s]+))").matcher(json);
    return m.find() ? (m.group(1) != null ? m.group(1) : m.group(2)) : "";
  }
}

Ausführen

Es gibt die ID des Renderings und die Download-URL aus, und og-image.png liegt neben dem Programm. Öffnen Sie es: 1200 × 630 Pixel, der Titel passend gekürzt, der Avatar rund.

export FORMFEED_API_KEY=ff_test_...
java Render.java

Was an Java besonders ist

• Keine JSON-Bibliothek im JDK. Um ohne Abhängigkeiten auszukommen, ist der Body ein Textblock, und die Werte, die das Programm aus JSON braucht (id und download_url des Renderings, eine Rechnungsnummer), liest ein regulärer Ausdruck. In einem Projekt bauen Sie den Body und lesen die Antwort mit Jackson oder Gson.
• Start aus einer Datei. java Render.java kompiliert und startet in einem Schritt; zum Ausprobieren braucht es kein Build-Tool.
• Direkt auf die Platte. BodyHandlers.ofFile streamt das PDF in die Datei, ohne es im Speicher zu halten.

Was die beiden Optionen tun

• output: "png". Nennt das Format des Bildes. jpg und webp gehen ebenso; Pixelmaß, Skalierungsfaktor und das Format einer Anfrage ohne output kommen aus den image-Einstellungen der Vorlage.
• access: "public". Liefert eine CDN-URL ohne Signatur, und genau das braucht ein Meta-Tag: Ein Scraper hat keinen API-Schlüssel. Die Adresse funktioniert so lange, wie die Datei aufbewahrt wird, worüber die Aufbewahrung Ihres Plans entscheidet; liefern Sie das gespeicherte Bild also von Ihrer eigenen Website aus, wenn eine Seite länger geteilt wird. Nutzen Sie es nur für Bilder, die öffentlich sein dürfen.

Einmal rendern, nicht bei jedem Aufruf

Eine identische Anfrage mit einem Live-Schlüssel innerhalb von 24 Stunden kommt zum Nulltarif aus dem Deduplizierungs-Cache; ein zweiter Deploy am selben Tag kostet also nichts (Test-Schlüssel kosten ohnehin nichts und werden nie dedupliziert). Danach wird das Bild neu gerendert: Speichern Sie das Bild oder seine URL beim Beitrag und rendern Sie, wenn sich der Beitrag ändert, nie im Seiten-Handler, denn ein Social-Scraper wartet nicht auf ein Rendering. Siehe Deduplizierung.

Eine Vorlage, viele Größen

Open Graph will 1200 × 630, andere Netzwerke wollen andere Maße. Schreiben Sie die Größe in settings.image der Anfrage statt in die Vorlage, dann rendert dasselbe Markup jedes Format, das Sie brauchen.

Wenn die API nein sagt

• Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
• Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
• Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Open-Graph-Bild-API.

Weitere Guides für Java

• PDF-Rechnung aus JSON erzeugen mit Java
• ZUGFeRD-E-Rechnung erstellen mit Java
• HTML in PDF umwandeln mit Java
• PDFs aus einer CSV erzeugen mit Java
• PDFs zusammenfügen und mit Passwort schützen mit Java
• PDF asynchron rendern und den Webhook prüfen mit Java

FAQ

Zählt das Bild als Rendering?

Ja, eine Einheit je Bild, wie ein einseitiges PDF. Test-Renderings sind kostenlos. Siehe Preise.

Kann ich eigene Schriften verwenden?

Ja: Verlinken Sie eine Webfont im Head der Vorlage, die der Renderer holt und cacht, oder laden Sie ab dem Starter-Tarif Schriftdateien in der App unter Schriften hoch und nennen Sie die Familie in Ihrem CSS. Siehe Schriften.

Warum ist mein Text abgeschnitten?

Der Rahmen ist fest, eine lange Überschrift muss also nachgeben. Das Beispiel kürzt mit truncate: 70; eine kleinere Schrift oder eine zweizeilige Begrenzung in CSS geht auch.

Open-Graph-Bild in anderen Sprachen

• Node.js (TypeScript)
• Python
• PHP
• Go
• C# (.NET)
• Ruby
• curl