如果有 json 和 text，选择哪种 API 响应格式？答案

【问题标题】：Which API response format to choose if there are json and text?如果有 json 和 text，选择哪种 API 响应格式？
【发布时间】：2025-12-25 13:15:16
【问题描述】：

我正在用 Python 编写一个 API 库，之前我总是选择 json 作为响应格式，但是这个 API 提供了 text 和 json格式，我不是问哪个更容易或更好，我想知道使用这两种格式的优缺点，因为我之前只使用过 json。

我考虑过使用 text 格式，它很容易解析，但我唯一想到的是嵌套元素，但在检查示例后，它们用下划线分隔 _ 例如：

name=VALUE
lastname=VALUE
age=VALUE
contact_email=VALUE
contact_phone=VALUE
contact_mobile=VALUE

同样的 json 响应：

{
    "name": "VALUE",
    "lastname": "VALUE",
    "age": "VALUE",
    "contact": {
        "email": "VALUE",
        "phone": "VALUE",
        "mobile": "VALUE"
    }
}

那么使用 text 而不是 json 或其他方式有什么优点或缺点？

【问题讨论】：

标签： python json api text

【解决方案1】：

恕我直言，json 优于文本的主要优点是：

DRY - 有用于 json 处理的第三方库，性能非常好
解析后的 json 最终成为一个 dict，您可以通过键轻松引用它

对于文本变体，有.ini 格式，它可以提供一些结构线，尽管您上面描述的格式并不是真正为嵌套字段和结构设计的。

我还会查看谁在使用您的 API。例如。如果它是一个网络应用程序，那么 json 是可接受的格式。如果您的消费者对文本格式更满意...

【讨论】：

【解决方案2】：

JSON 可以更简单，因为您可以使用 json 库。

您在那里显示的返回值可以用以下行放入字典中：

import json
json.loads(return_string)

比文本更容易解析！

【讨论】：