javascript - 响应对象的 JSON 对象到 api 端点

Question

嗯，这是我的第一个 nodeJS 应用程序。我一直在研究 RESTful API 最佳实践，但似乎没有一个能直接解决我的顾虑。

这是我的数据保存在数据库中的格式:

'1212': {
    name: 'Plasma Blaster',
    id: 1212,
    price: 7000,
    quantity: 10,
    minimum: false,
    date: new Date().toISOString().replace('T', ' ').substr(0, 19),
    image: 'http://www.img.com/image.jpeg',
},

每个项目都使用其唯一 ID 的字符串作为键保存。顺便说一句，我使用简单的数据结构作为数据库。

向端点 /api/v1/store/products 发出的获取请求返回结果:

{
"completed": true,
"message": "get products sucessful",
"products": {
    "1370": {
        "name": "DH-17 blaster pistol",
        "id": 1370,
        "price": 600,
        "quantity": 10,
        "minimum": "false",
        "date": "2018-11-05 13:29",
        "image": "http://www.img.com/image.jpeg"
    },
    "1473": {
        "name": "C-22 fragmentation grenade",
        "id": 1473,
        "price": 200,
        "quantity": 16,
        "minimum": "false",
        "date": "2018-11-05 13:32",
        "image": "http://www.img.com/image.jpeg"
    },
    "8385": {
        "name": "Neon-Blue Crystal Lightsaber",
        "id": 8385,
        "price": 200,
        "quantity": 1,
        "minimum": "true",
        "date": "2018-11-05 13:35",
        "image": "http://www.img.com/image.jpeg"
    },
    "0836": {
        "name": "Treppus-2 vibroblade",
        "id": 836,
        "price": 2000,
        "quantity": 1,
        "minimum": "true",
        "date": "2018-11-05 13:36",
        "image": "http://www.img.com/image.jpeg"
    }
}

我需要知道这是否是一个可接受的结构。我之前使用过的 Api 响应结构是对象数组。我也将感谢帮助更好地格式化它。

Answer 1

关于 JSON 资源的“可接受结构”的指南并不多，大多数人只关心您是否保持一致。

也就是说，我认为您的“完成”和“消息”键不会添加太多，因为根据 HTTP 响应代码(例如 200 Success)，它们应该是显而易见的。客户可能会发现使用数组代替对象稍微容易一些，但这不是一个问题