为 API 构建请求 JSON

Question

我正在为其他项目构建一个小型 API 来与我们的数据库进行交互。我已经构建了数据库并且 API 运行良好，但是，我返回的数据不是我想要的结构。

我将 Python 与 Flask/Flask-Restful 一起用于 API。 这是我处理交互的 Python 的 sn-p：

class Address(Resource):
    def get(self, store):
        print('Received a request at ADDRESS for Store ' + store )
        conn = sqlite3.connect('store-db.db')
        cur = conn.cursor()
        addresses = cur.execute('SELECT * FROM Sites WHERE StoreNumber like ' + store)     
        for adr in addresses:
            return(adr, 200)

如果我向 /sites/42 端点发出请求，其中 42 是站点 ID，我将收到以下信息：

[
    "42",
    "5000 Robinson Centre Drive",
    "",
    "Pittsburgh",
    "PA",
    "15205",
    "(412) 787-1330",
    "(412) 249-9161",
    "",
    "Dick's Sporting Goods"
]

这是它在数据库中的结构：

最终我想使用列名作为接收到的 JSON 中的键，但我需要一些正确方向的指导，所以我不会在谷歌上搜索模棱两可的术语，希望能找到一些东西。

这是我在向该端点发出请求后希望收到的示例：

{
    "StoreNumber": "42",
    "Street": "5000 Robinson Centre Drive",
    "StreetSecondary": "",
    "City": "Pittsburgh",
    "State": "PA",
    "ZipCode": "15205",
    "ContactNumber": "(412) 787-1330",
    "XO_TN": "(412) 249-9161",
    "RelocationStatus": "",
    "StoreType": "Dick's Sporting Goods"
}

我只是想获得一些指导，了解我是否应该更改我的数据在数据库中的结构（即我看到有些人只是将 JSON 放入他们的数据库中，但我认为这很混乱）或者是否有一个我可以使用更直观的方法来控制我的数据。

使用接受的答案更新代码

class Address(Resource):
    def get(self, store):
        print('Received a request at ADDRESS for Store ' + store )
        conn = sqlite3.connect('store-db.db')
        cur = conn.cursor()
        addresses = cur.execute('SELECT * FROM Sites WHERE StoreNumber like ' + store)     
        for r in res:
            column_names = ["StoreNumber", "Street", "StreetSecondary","City","State", "ZipCode", "ContactNumber", "XO_TN", "RelocationStatus", "StoreType"]
            data = [r[0], r[1], r[2], r[3], r[4], r[5], r[6], r[7], r[8]]            
            datadict = {column_names[itemindex]:item for itemindex, item in enumerate(data)}
            return(datadict, 200)

Answer 1

您可以将列表转换为 dict，然后将其解析为 JSON 字符串，然后再将其传回。

// These are the names of the columns in your database
>>> column_names = ["storeid", "address", "etc"]

// This is the data coming from the database.
// All data is passed as you are using SELECT * in your query
>>> data = [42, "1 the street", "blah"]

// This is a quick notation for creating a dict from a list
// enumerate means we get a list index and a list item
// as the columns are in the same order as the data, we can use the list index to pull out the column_name
>>> datadict = {column_names[itemindex]:item for itemindex, item in enumerate(data)}

//This just prints datadict in my terminal
>>> datadict

我们现在有一个包含您的数据和列名的命名字典。

{'etc': 'blah', 'storeid': 42, 'address': '1 the street'}

现在将 datadict 转储为字符串，以便将其发送到前端。

>>> import json
>>> json.dumps(datadict)

字典现在已经转换成字符串了。

'{"etc": "blah", "storeid": 42, "address": "1 the street"}'

这不需要更改您的数据库，但脚本需要了解列名或使用某些 SQL 动态检索它们。

如果数据库中的数据以正确的格式传递到前端，那么您不需要更改数据库结构。如果它的格式不正确，那么您可以更改它的存储方式或更改您的 SQL 查询来操作它。