JSON 工具

接口标识: jsontool 价格: 0.005 元/次同步响应

接口介绍
接口文档
在线测试

接口简介

JSON 工具接口把五种常用 JSON 处理收进一个入口：格式化（缩进 0~8 可设，默认 2）、压缩为单行、校验合法性并定位错误原因、转换为 YAML 或 XML、用 JSONPath 表达式提取嵌套数据中的字段并返回命中数组与数量。单次处理文本最长 100 万字符，结果保留中文原样不转义，XML 转换要求顶层为 JSON 对象。适合接口联调、配置文件格式转换、报文校验与数据字段提取场景。

详细介绍

![JSON 工具接口封面](https://fujian.phpwc.com/pyapi/uploads/site/20261111/apiops_jsontool__1794363291_96d310236576.png)

JSON 解析不通、想转成 YAML、想提取深层字段？一个入口搞定格式化、压缩、校验、转换与查询五种操作。

## 接口概述
面向开发与联调中高频处理 JSON 的场景，接口把五种常用操作收进同一个入口：把 JSON 文本格式化为标准缩进、压缩成单行以便存储传输、校验文本合法性并给出错误原因、转换为 YAML 或 XML、用 JSONPath 表达式提取嵌套结构中的深层字段。所有操作同步返回，结果以纯文本或数组形式给出，可嵌入编辑器插件、运维后台与接口调试面板，替代前端各自造轮子。

## 核心能力
1. **格式化与压缩**：缩进 0~8 空格可设，压缩输出单行紧凑文本，中文原样保留不转义。
2. **合法性校验**：返回是否合法与具体解析错误原因，校验失败不中断调用。
3. **格式转换**：JSON 一键转 YAML 或 XML，XML 以 root 为根、数组转为 item 节点。
4. **JSONPath 查询**：表达式提取嵌套数据中的目标字段，返回命中数组与命中数量。

## 产品优势
1. **一入口多能力**：五种操作共用一个调用入口与响应结构，无需分别对接多个工具。
2. **接入简单**：POST 同步返回，结果即取即用。
3. **中文友好**：格式化与转换结果保留中文原样，便于直接阅读与展示。
4. **错误清晰**：校验与解析类操作返回具体错误原因，定位问题更快。
5. **降本增效**：编辑器插件、内部后台的常见调试能力即接即用，免去重复开发。

## 效果展示
一句话理解：它就像一位文本管家——把皱巴巴的 JSON 抚平对齐、把长文压成一行、把错误挑出来，还能顺手换成另一种格式。

以一次真实调用为例，你要传的参数：

| 参数 | 本次示例值 | 说明 |
|------|-----------|------|
| action | format | 操作类型：format / compress / validate / convert / jsonpath |
| content | {"name":"商品A","price":… | 待处理的 JSON 文本，最长 1000000 字符 |
| indent | 2 | 格式化缩进空格数，0~8，默认 2，仅 format 使用 |

你会拿到的结果：

| 返回内容 | 本次示例值 | 对应字段 |
|---------|-----------|---------|
| 格式化后的文本 | 缩进 2 空格的标准 JSON | `result`，中文原样保留不转义 |

API请求示例：

```
POST /api/jsontool
{
  "action": "format",
  "content": "{\"name\":\"商品A\",\"price\":99.5,\"tags\":[\"热销\",\"新品\"]}",
  "indent": 2
}
```

API响应示例：

```json
{
  "code": 0,
  "desc": "成功",
  "data": {
    "result": "{\n  \"name\": \"商品A\",\n  \"price\": 99.5,\n  \"tags\": [\n    \"热销\",\n    \"新品\"\n  ]\n}"
  },
  "request_id": "d6f8a0b2c4e143579b1d3f5a7c9e0b2d"
}
```

format、compress、convert 均只返回 result 字段；validate 返回 valid 与 error_msg，jsonpath 返回 matches 与 count，按 action 各取所需。

## 应用场景
- **联调排错**：快速校验接口返回报文是否合法，并格式化成可读形式。
- **配置转换**：把 JSON 配置转为 YAML 或 XML，适配不同系统的配置格式。
- **数据提取**：用 JSONPath 从嵌套报文中取出目标字段，供下游流程使用。
- **存储压缩**：报文入库前压缩为单行，减少存储与传输体积。

## 应用案例
**后台系统开发者**：自建管理后台需要给运营人员提供 JSON 美化与校验功能，又不想在前端维护解析与报错定位逻辑。接入本接口后，粘贴文本即可格式化或拿到具体错误原因，中文商品名原样显示，功能一天上线。

**数据对接工程师**：两套系统对接时，一边只认 YAML 配置、一边只出 JSON。现在用本接口的转换能力一键互转，再用 JSONPath 抽取关键字段做比对校验，对接调试周期从一周缩短到两天。

常见问题

Q：校验不合法的 JSON 会报错吗？

A：不会。validate 操作返回 valid=false，error_msg 给出具体的解析错误原因，便于定位问题字符位置。

Q：转 XML 有什么限制？

A：顶层必须是 JSON 对象（字典）；数组会转换为 item 节点。转 YAML 无此限制。

Q：content 有大小限制吗？

A：最长 1000000 字符，超出返回参数错误；格式化与转换结果保留中文原样，不转义为编码。

JSON 格式化开发工具数据转换

接口地址： https://www.phpwc.cn/api/jsontool

请求方式： POST

业务请求参数

参数名	类型	必填	默认值	说明
`action`	string	必填	-	操作：format/compress/validate/convert/jsonpath
`content`	string	选填	-	JSON 文本
`target_format`	string	选填	`yaml`	convert 目标格式：yaml/xml
`path`	string	选填	-	jsonpath 表达式
`indent`	int	选填	`2`	format 缩进

查看签名算法查看调用示例

响应参数

字段名	类型	说明
`code`	int	状态码，0=成功
`desc`	string	状态描述
`data`−	object	业务数据（成功时返回）
`result`	string	结果文本
`valid`	boolean	validate 是否合法
`error_msg`	string	错误信息
`matches`	array	jsonpath 命中数组
`count`	int	命中数量
`request_id`	string	请求追踪ID

JSON 示例：

调用成功：

{
  "code": 0,
  "desc": "success",
  "data": { ... },
  "request_id": "abc123..."
}

调用失败：

{
  "code": 999,
  "desc": "错误描述",
  "request_id": "abc123..."
}

请先登录后使用在线测试