Python编写api接口读取电商商品详情数据示例

一个专注api接口开发的小白
136 阅读4分钟

​

以下是一个使用 Python 的 Flask 框架来编写一个简单的 API 接口，用于读取模拟的电商商品详情数据的示例代码。这里假设商品详情数据是存储在一个简单的字典中模拟数据库存储，实际应用中你需要连接真正的数据库（如 MySQL、MongoDB 等）来获取数据。

1. 安装 Flask

如果还没有安装 Flask 框架，在命令行中执行以下命令安装：

pip install flask

2. 编写 Python 代码

from flask import Flask, jsonify

app = Flask(__name__)

# 模拟商品详情数据，实际中可从数据库获取
products = {
    "1": {
        "name": "示例商品1",
        "price": 99.99,
        "description": "这是一款示例商品，具有不错的功能。",
        "category": "电子产品"
    },
    "2": {
        "name": "示例商品2",
        "price": 49.99,
        "description": "另一个示例商品，很实用。",
        "category": "生活用品"
    }
}


@app.route('/product/<product_id>', methods=['GET'])
def get_product_detail(product_id):
    """
    根据商品ID获取商品详情的接口函数
    """
    product = products.get(product_id)
    if product:
        return jsonify(product)
    return jsonify({"message": "未找到该商品"}), 404


if __name__ == '__main__':
    app.run(debug=True)

3. 代码解释

  • 导入必要模块：
from flask import Flask, jsonify

 

这里导入了Flask类用于创建 Web 应用实例，jsonify函数用于将 Python 对象（如字典）转换为 JSON 格式的数据响应给客户端，符合 API 返回数据的常见格式要求。

  • 创建 Flask 应用实例和模拟数据：
app = Flask(__name__)

# 模拟商品详情数据，实际中可从数据库获取
products = {
    "1": {
        "name": "示例商品1",
        "price": 99.99,
        "description": "这是一款示例商品，具有不错的功能。",
        "category": "电子产品"
    },
    "2": {
        "name": "示例商品2",
        "price": 49.99,
        "description": "另一个示例商品，很实用。",
        "category": "生活用品"
    }
}

 

创建了一个名为app的 Flask 应用实例，并且定义了一个名为products的字典来模拟商品详情数据，其中键为商品的唯一标识（这里简单用字符串表示），值是包含商品各属性（名称、价格、描述、分类等）的字典。

  • 定义 API 路由和视图函数：
@app.route('/product/<product_id>', methods=['GET'])
def get_product_detail(product_id):
    """
    根据商品ID获取商品详情的接口函数
    """
    product = products.get(product_id)
    if product:
        return jsonify(product)
    return jsonify({"message": "未找到该商品"}), 404

 

通过@app.route装饰器定义了一个路由，路径为/product/<product_id>，其中<product_id>是一个动态的参数，代表要获取详情的商品的标识。当客户端发起 GET 请求到这个路径时，get_product_detail函数会被调用，函数内部尝试从products字典中获取对应商品的数据，如果找到则通过jsonify将其转换为 JSON 格式返回给客户端，如果没找到则返回一个包含错误消息的 JSON 响应，状态码设置为404表示资源未找到。

  • 启动应用：
if __name__ == '__main__':
    app.run(debug=True)

 

这段代码确保当脚本直接运行时（而不是被作为模块导入时）启动 Flask 应用，并且开启调试模式（debug=True）方便开发阶段查看调试信息。

你可以通过访问类似http://127.0.0.1:5000/product/1（假设本地运行，且商品 ID 为1）这样的 URL 来获取对应的商品详情数据。

请注意，这只是一个非常基础的示例，实际应用中还需要考虑诸多方面，比如：

  • 更完善的数据库连接和查询操作来获取真实数据。
  • 对请求的参数验证、错误处理、鉴权等功能添加（例如验证商品 ID 是否合法等）。
  • 配置合适的服务器部署到生产环境等。

如果要使用其他的 Python 库来搭建 API 接口，比如 FastAPI 等，实现思路类似，但代码结构和语法会有所不同。以下是一个使用 FastAPI 实现类似功能的简单示例供你参考对比：

安装 FastAPI 及相关依赖（uvicorn 用于运行应用）

pip install fastapi
pip install uvicorn

 代码示例

from fastapi import FastAPI

app = FastAPI()

# 模拟商品详情数据，实际中可从数据库获取
products = {
    "1": {
        "name": "示例商品1",
        "price": 99.99,
        "description": "这是一款示例商品，具有不错的功能。",
        "category": "电子产品"
    },
    "2": {
        "name": "示例商品2",
        "price": 49.99,
        "description": "另一个示例商品，很实用。",
        "category": "生活用品"
    }
}


@app.get("/product/{product_id}")
async def get_product_detail(product_id: str):
    """
    根据商品ID获取商品详情的接口函数
    """
    product = products.get(product_id)
    if product:
        return product
    return {"message": "未找到该商品"}

 

运行 FastAPI 应用

在命令行中执行以下命令（假设代码保存为main.py）：

uvicorn main.py:app --reload

FastAPI 相对 Flask 在性能等方面有一定优势，并且代码结构更简洁，自动生成的文档（基于 Swagger 等）更方便查看和测试接口，但具体使用哪种框架可以根据项目的实际需求和团队的技术偏好等来选择。

​

avatar
文章
阅读
粉丝