Zum Inhalt springen
POST AI agent ready /v1/json/format

JSON-Formatierungs-API – Pretty-Print mit benutzerdefiniertem Einzug

Nimmt eine kompakte oder schlecht formatierte JSON-Zeichenfolge und gibt sie mit konsistenter Einrückung und Zeilenumbrüchen zurück. Konfigurieren Sie die Einzugsgröße (2 oder 4 Leerzeichen sind üblich), passend zu Ihrem Projektstil.

Parameters

stringrequired

The JSON string to format.

number

Number of spaces per indentation level.

Code examples

curl -X POST https://api.botoi.com/v1/json/format \
  -H "Content-Type: application/json" \
  -d '{"json":"{\"name\":\"botoi\",\"version\":2}","indent":2}'

When to use this API

API-Antworten für die Protokollierung formatieren

Drucken Sie API-Antwortkörper hübsch aus, bevor Sie sie in Protokolldateien schreiben, damit Entwickler sie während des Debuggens scannen können.

Erstellen Sie einen Konfigurationsdatei-Viewer

Zeigen Sie formatierte JSON-Konfigurationsdateien in einem Admin-Dashboard an, damit technisch nicht versierte Benutzer die Einstellungen lesen und überprüfen können.

Standardisieren Sie die Einrückung in CI-Pipelines

Führen Sie diesen Endpunkt in einem CI-Schritt aus, um zu überprüfen, ob alle eingecheckten JSON-Dateien einer konsistenten 2-Leerzeichen- oder 4-Leerzeichen-Einrückungsregel folgen.

Frequently asked questions

Welche Einrückungsebenen werden unterstützt?
Jede positive ganze Zahl funktioniert, am häufigsten sind jedoch 2 und 4. Der Standardwert ist 2 Leerzeichen.
Ändert die Formatierung die Daten in irgendeiner Weise?
Nein. Die Ausgabe ist semantisch identisch mit der Eingabe. Lediglich Leerzeichen und Zeilenumbrüche ändern sich.
Was passiert, wenn der Eingabe-JSON ungültig ist?
Die API gibt einen Fehler mit dem Ort des Analysefehlers zurück, sodass Sie das Syntaxproblem beheben können.
Kann ich JSON mit Tabulatoreinzug anstelle von Leerzeichen formatieren?
Die API unterstützt derzeit nur die leerzeichenbasierte Einrückung. Stellen Sie den Einzugsparameter auf die gewünschte Anzahl von Leerzeichen ein.

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.