Spree Wishlist 项目技术文档

1. 安装指南

在开始使用Spree Wishlist扩展之前，您需要按照以下步骤进行安装：

• 将以下内容添加到您的Gemfile文件中：

  gem 'spree_wishlist', github: 'spree-contrib/spree_wishlist', branch: 'master'
  

• 运行以下命令来安装依赖项并进行必要的设置：

  bundle install
  bundle exec rails g spree_wishlist:install
  

请确保您的环境已经安装了Spree，并且所有的依赖项都已正确配置。

2. 项目使用说明

Spree Wishlist扩展允许用户创建和管理多个心愿单，这些心愿单可以是公开的（可共享）或私有的。此外，用户还可以通过电子邮件向朋友推荐产品。

3. 项目API使用文档

在使用API前，请先阅读Spree API v1 summary。

以下是可用的API端点：

心愿单管理

• GET /api/v1/wishlists - 返回当前登录用户的心愿单列表。

• GET /api/v1/wishlists/:id - 返回指定ID的心愿单及其产品列表。

• POST /api/v1/wishlists - 创建一个新的心愿单。

  请求内容：

  {
    "wishlist": {
      "name": "父亲节礼物"
    }
  }
  

• PATCH /api/v1/wishlists/:id - 更新指定ID的心愿单。

  请求内容：

  {
    "wishlist": {
      "name": "新名称"
    }
  }
  

• DELETE /api/v1/wishlists/:id - 删除指定ID的心愿单。

心愿单产品管理

• POST /api/v1/wished_products - 将产品（变体）添加到心愿单。

  请求内容：

  {
    "wished_product": {
      "variant_id": 2,
      "wishlist_id": 1
    }
  }
  

• PATCH /api/v1/wished_products/:id - 更新指定ID的心愿单中的产品。

  请求内容：

  {
    "wished_product": {
      "variant_id": 3,
      "wishlist_id": 2
    }
  }
  

• DELETE /api/v1/wished_products/:id - 从心愿单中删除指定ID的产品。

心愿单V2

心愿单管理

• GET /api/v2/storefront/wishlists - 返回当前登录用户的心愿单列表。

• GET /api/v2/storefront/wishlists/:access_hash - 返回具有特定访问哈希的心愿单及其产品列表。

  请求参数：

  {
    "include": "wished_products.variant"
  }
  

• PATCH /api/v2/storefront/wishlists/:access_hash - 更新具有特定访问哈希的心愿单。

  请求内容：

  {
    "wishlist": {
      "name": "心愿单名称",
      "is_default": true,
      "is_private": true
    }
  }
  

• POST /api/v2/storefront/wishlists - 创建一个新的心愿单。

  请求内容：

  {
    "wishlist": {
      "name": "心愿单名称",
      "is_default": true,
      "is_private": true
    }
  }
  

• DELETE /api/v2/storefront/wishlists/:access_hash - 删除具有特定访问哈希的心愿单。

心愿单产品管理

• POST /api/v2/storefront/wishlists/:access_hash/wished_products - 将产品（变体）添加到具有特定访问哈希的心愿单。

  请求内容：

  {
    "wished_product": {
      "variant_id": 2,
      "remark": "我想要这个",
      "quantity": 3
    }
  }
  

• PATCH /api/v2/storefront/wishlists/:access_hash/wished_products/:id - 更新具有特定访问哈希的心愿单中的产品。

  请求内容：

  {
    "wished_product": {
      "variant_id": 2,
      "remark": "我想要这个",
      "quantity": 4
    }
  }
  

• DELETE /api/v2/storefront/wishlists/:access_hash/wished_products/:id - 从具有特定访问哈希的心愿单中删除产品。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，请参照执行以下步骤：

• 修改Gemfile，添加Spree Wishlist扩展。
• 运行bundle install安装依赖项。
• 执行bundle exec rails g spree_wishlist:install进行必要的设置。

以上步骤将帮助您成功安装Spree Wishlist扩展，并开始使用其功能。