跳转到内容
POST AI agent ready /v1/json/format

JSON Formatter API - 具有自定义缩进的漂亮打印

获取紧凑或格式不良的 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 目前仅支持基于空格的缩进。 将缩进参数设置为您首选的空格数。

Get your API key

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