Question

我想知道用于编写REST API响应的实践： -

{
    "Headline": {
        "score": 10,
        "summary": "Public Url Description.",
        "status": 1,
        "description": "Perfect! The URL contains your name"
    },
    "Profile Picture": {
        "score": 10,
        "summary": "Profile Picture Description.",
        "status": 1,
        "description": "Amazing Job, Now you are more approachable."
    }
}

OR

{
    "status": 200,
    "response": {
        "Headline": {
            "score": 10,
            "summary": "Public Url Description.",
            "status": 1,
            "description": "Perfect! The URL contains your name"
        },
        "Profile Picture": {
            "score": 10,
            "summary": "Profile Picture Description.",
            "status": 1,
            "description": "Amazing Job, Now you are more approachable."
        }
    }
}

我是编写API的新手。我想知道哪种做法可以帮助我编写更好的API。

我使用CakePHP作为框架。

我应该在API响应中添加响应代码吗？

Answer 1

第二个响应重复已经处于HTTP响应状态的信息。 HTTP状态将为chart.series[0].update({ name: "hello"});或服务器设置的任何其他HTTP状态代码。如果你不小心保持两个值相等，那么在响应体中复制它只会导致混淆。

使用第一个表单。

Answer 2

我向@Lutz's answer添加了一个标准，即当通过RESTful API返回JSON数据时，整个行业都没有标准。

然而，有些人正试图将其标准化。

有关详细信息，请参阅http://jsonapi.org/。

编写REST API响应的最佳实践是什么？

2 个答案: