php - Web服务API设计中哪种schema更好

Question

最近，我们的团队要为我们现有的网站开发移动(iphone、android 平台)应用程序，让用户可以使用该应用程序更方便地通过该应用程序阅读我们的内容。

但我们的团队对 API 返回的 JSON 模式有不同的看法，下面是示例响应。

模式类型 1:

{
"success": 1,
"response": {
    "threads": [
        {
            "thread_id": 9999,
            "title": "Topic haha",
            "content": "blah blah blah",
            "category": {
                "category_id": 100,
                "category_name": "Chat Room",
                "category_permalink": "http://sample.com/category/100"
            },
            "user": {
                "user_id": 1,
                "name": "Hello World",
                "email": "helloworld@hello.com",
                "user_permalink": "http://sample.com/user/Hello_World"
            },
            "post_ts": "2012-12-01 18:16:00T0800"
        },
        {
            "thread_id": 9998,
            "title": "asdasdsad ",
            "content": "dsfdsfdsfds dsfdsf ds",
            "category": {
                "category_id": 101,
                "category_name": "Chat Room 2",
                "category_permalink": "http://sample.com/category/101"
            },
            "user": {
                "user_id": 2,
                "name": "Hello baby",
                "email": "hellobaby@hello.com",
                "user_permalink": "http://sample.com/user/2"
            },
            "post_ts": "2012-12-01 18:15:00T0800"
        }
    ]
}
}

模式类型 2:

{
"success": 1,
"response": {
    "threads": [
        {
            "thread_id": 9999,
            "title": "Topic haha",
            "content": "blah blah blah",
            "category": 100,
            "user": 1,
            "post_ts": "2012-12-01 18:16:00T0800"
        },
        {
            "thread_id": 9998,
            "title": "asdasdsad ",
            "content": "dsfdsfdsfds dsfdsf ds",
            "category": 101,
            "user": 2,
            "post_ts": "2012-12-01 18:15:00T0800"
        }
    ],
    "category": [
        {
            "category_id": 100,
            "category_name": "Chat Room",
            "category_permalink": "http://sample.com/category/100"
        },
        {
            "category_id": 101,
            "category_name": "Chat Room 2",
            "category_permalink": "http://sample.com/category/101"
        }
    ],
    "user": [
        {
            "user_id": 1,
            "name": "Hello World",
            "email": "helloworld@hello.com",
            "user_permalink": "http://sample.com/user/Hello_World"
        },
        {
            "user_id": 2,
            "name": "Hello baby",
            "email": "hellobaby@hello.com",
            "user_permalink": "http://sample.com/user/Hello_baby"
        }
    ]
}
}

一些开发人员声称，如果使用模式类型 2，

• 如果类别和用户实体重复太多，可以减少数据大小。它确实减少了至少 20~40% 的响应纯文本大小。
• 一旦数据大小变小，在将其解析为 JSON 对象时，内存变小
• categoey & user可以存储在hash-map中，方便复用
• 减少检索数据的开销

我不知道模式类型 2 是否真的增强了。因为看了那么多API文档，从来没见过这种schema设计。对我来说，它看起来像一个关系数据库。所以我没有什么问题，因为我没有设计 Web 服务 API 的经验。

• 它是否违反 API 设计原则(易于阅读，易于使用)？
• 在 IOS/Android 平台上解析真的会变得更快并且占用更少的内存资源吗？
• 是否可以减少客户端和服务器之间的开销？

谢谢。

Answer 1

当我为 android 做这样的应用程序时，我只解析一个 JSON 并将其放入数据库中。后来我使用 ContentProvider 来访问它。在您的情况下，您可以使用第二个模式但没有用户、类别部分。改用延迟加载，但这将是一个很好的解决方案，以防类别和用户经常重复。