Vendure电商平台API快速上手指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00480/article/details/148488026

Vendure电商平台API快速上手指南

vendure A headless GraphQL commerce platform for the modern web 项目地址: https://gitcode.com/gh_mirrors/ve/vendure

前言

Vendure是一个现代化的电商平台解决方案，基于Node.js和GraphQL构建。本文将带您快速体验Vendure的API功能，帮助您理解其核心特性和使用方法。

准备工作

在开始之前，请确保您已经完成了Vendure的本地安装，并在安装过程中选择了填充示例数据。这些示例数据将帮助我们更好地演示API功能。

GraphiQL交互界面

Vendure内置了GraphiQL工具，这是一个强大的GraphQL API探索和测试界面。它允许您：

直观地编写和执行GraphQL查询
实时查看API响应
浏览完整的API文档
测试Shop API和Admin API

GraphiQL界面分为三个主要区域：

左侧：查询编辑器
中间：执行结果展示区
右侧：API文档浏览器

Shop API实战

Shop API是面向客户的公开API，主要用于前端商城应用。

基础查询示例

让我们从最简单的产品查询开始：

query GetProducts {
    products {
      totalItems
      items {
        id
        name
      }
    }
}

这个查询展示了GraphQL的核心优势之一：精确数据获取。客户端只需请求需要的数据字段，服务器就只返回这些字段。

扩展查询字段

我们可以轻松扩展查询，获取更多产品信息：

query GetProducts {
    products {
      totalItems
      items {
        id
        name
        slug
        description
        featuredAsset {
          id
          preview
        }
      }
    }
}

注意featuredAsset字段是一个嵌套对象，我们可以继续深入查询其子字段，这体现了GraphQL的嵌套查询能力。

查询参数化

GraphQL支持强大的参数化查询：

query GetProducts {
    products(options: { 
      take: 5,
      filter: {
        name: { contains: "shoe" }
      }
    }) {
      totalItems
      items {
        id
        name
      }
    }
}

这个查询展示了：

take参数：限制返回结果数量
filter参数：按名称筛选产品

数据修改操作

除了查询，我们还可以执行修改数据的mutation操作。

添加商品到订单

mutation AddItemToOrder {
    addItemToOrder(productVariantId: 42, quantity: 1) {
      ...on Order {
        id
        code
        totalQuantity
        totalWithTax
        lines {
          productVariant {
            name
          }
          quantity
          linePriceWithTax
        }
      }
      ...on ErrorResult {
        errorCode
        message
      }
    }
}

这个mutation展示了几个重要概念：

使用变量参数(productVariantId, quantity)
使用**片段(fragment)**处理不同类型的返回结果
错误处理机制

Admin API深度探索

Admin API提供了完整的后台管理功能，比Shop API暴露更多数据。

管理员登录

大多数Admin API操作需要认证：

mutation Login {
    login(username: "superadmin", password: "superadmin") {
        ... on CurrentUser {
            id
            identifier
        }
        ... on ErrorResult {
            errorCode
            message
        }
    }
}

高级产品查询

query GetProduct {
  product(id: 42) {
    enabled
    name
    variants {
      id
      name
      enabled
      prices {
        currencyCode
        price
      }
      stockLevels {
        stockLocationId
        stockOnHand
        stockAllocated
      }
    }
  }
}

Admin API提供了更详细的产品信息，包括：