跳到主要内容

JSON 处理接口指南


概述

本文档介绍 A1 平台 JSON 处理相关的接口函数及参数定义。支持 JSON 数据的删除、插入、读取和替换操作,适用于数据清理、配置管理和数据预处理等场景。


一、json_process_delete

功能说明

从 JSON 对象中删除指定的键值对。适用于需要从复杂 JSON 数据中移除某些字段的场景,例如构建动态表单、清理 API 响应等。

输入参数

参数名类型必填说明
inputObject*要操作的 JSON 对象
delete_valueString*需要从 input 中删除的键名

输出参数

参数名类型说明
resultObject返回删除指定键后的 JSON 对象

二、json_process_insert

功能说明

向 JSON 对象中插入新的键值对。适用于需要动态扩展 JSON 数据的场景。

输入参数

参数名类型必填说明
inputObject*要操作的原始 JSON 对象
insert_valueString*要插入的键名
insert_dataString*要插入的键对应的值

输出参数

参数名类型说明
resultObject返回包含新插入键值对的 JSON 对象

三、json_process_read

功能说明

从 JSON 对象中读取指定键的值。适用于需要提取 JSON 数据中特定字段信息的场景。

输入参数

参数名类型必填说明
inputObject*要操作的原始 JSON 对象
read_valueString*要读取的键名

输出参数

参数名类型说明
resultString从 JSON 对象中读取到的键对应的值

四、json_process_replace

功能说明

对 JSON 对象中的特定键进行替换操作,包括键名和键值的替换。适用于需要更新 JSON 数据结构或修改特定字段值的场景。

输入参数

参数名类型必填说明
inputObject*要操作的原始 JSON 对象
read_valueString*要读取并被替换的键名
replace_valueString*替换后的新键名
replace_dataString*替换后的新键对应的值

输出参数

参数名类型说明
resultObject返回包含替换后内容的 JSON 对象

五、使用示例

5.1 删除字段流程

5.2 插入字段流程

5.3 读取字段流程

5.4 替换字段流程

5.5 完整业务场景


六、注意事项

项目说明
数据格式input 参数必须是有效的 JSON 对象格式
键名存在性删除和读取操作时,确保指定的键名存在于对象中
类型转换插入和替换的值会以字符串形式处理,如需其他类型请在使用时转换
嵌套对象当前版本仅支持顶层键的操作,不支持嵌套路径(如 a.b.c
错误处理建议对接口返回结果进行异常捕获和处理

如有疑问,请联系技术支持。