欢迎访问 产品 API 接口说明,以下是核心功能及使用指南:


📋 1. 接口概述

本接口提供产品信息的增删改查功能,支持以下操作:

  • 📦 查看产品列表
  • 🔍 搜索特定产品
  • ✏️ 更新产品详情
  • 🗑️ 删除产品

📌 通过 /product-management 可了解更多产品管理相关规范


📋 2. 请求路径

方法 路径 描述
GET /api-product/list 获取全部产品信息
GET /api-product/search?name=<关键词> 按名称搜索产品
POST /api-product/create 新增产品
PUT /api-product/update/<id> 修改指定产品
DELETE /api-product/delete/<id> 删除指定产品

🌟 例:/api-product/search?name=Smartphone 将返回所有包含“Smartphone”的产品


📎 3. 参数说明

  • id:产品唯一标识符(数字)
  • name:产品名称(字符串)
  • description:产品描述(文本)
  • price:产品价格(数值)

📸 示例参数可视化:

API_Parameter


📌 4. 返回格式

所有请求返回 JSON 数据结构,示例如下:

{
  "code": 200,
  "message": "成功",
  "data": [
    {
      "id": 1,
      "name": "无线耳机",
      "description": "支持蓝牙5.2的高保真耳机",
      "price": 199.99
    }
  ]
}

📌 了解更多响应规范:API 响应格式指南


📌 5. 使用建议

  • ✅ 推荐使用 GET 查询数据,避免不必要的资源消耗
  • ⚠️ 删除操作需谨慎,建议先通过 GET 确认产品信息
  • 📈 支持分页查询,参数 pagelimit 可优化大数据量处理

📸 接口使用示例:

API_Usage