コンテンツへスキップ
POST AI agent ready /v1/json/format

JSON フォーマッタ API - カスタム インデントを使用したきれいな印刷

コンパクトな JSON 文字列または適切にフォーマットされていない JSON 文字列を受け取り、一貫したインデントと改行を付けて返します。 プロジェクトのスタイルに合わせてインデント サイズ (スペース 2 つまたはスペース 4 つが一般的) を構成します。

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 応答をフォーマットする

API 応答本文をログ ファイルに書き込む前に整形して、開発者がデバッグ中にスキャンできるようにします。

構成ファイルビューアを構築する

フォーマットされた JSON 構成ファイルを管理者ダッシュボードに表示して、技術者以外のユーザーでも設定を読んで確認できるようにします。

CI パイプラインのインデントを標準化する

CI ステップでこのエンドポイントを実行して、チェックインされたすべての JSON ファイルが一貫した 2 スペースまたは 4 スペースのインデント ルールに従っていることを確認します。

Frequently asked questions

どのようなインデントレベルがサポートされていますか?
任意の正の整数を使用できますが、2 と 4 が最も一般的です。 デフォルトは 2 スペースです。
フォーマットするとデータが何らかの形で変更されますか?
いいえ。出力は入力と意味的に同じです。 空白と改行のみが変更されます。
入力された JSON が無効な場合はどうなりますか?
API は解析失敗の場所を示すエラーを返すため、構文の問題を修正できます。
スペースの代わりにタブインデントを使用して JSON をフォーマットできますか?
API は現在、スペースベースのインデントのみをサポートしています。 indent パラメータを希望のスペース数に設定します。

Get your API key

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