PizzaQL API完全参考：查询、变更与订阅操作实战示例

PizzaQL API完全参考：查询、变更与订阅操作实战示例

【免费下载链接】pizzaql:pizza: Modern OSS Order Management System for Pizza Restaurants项目地址: https://gitcode.com/gh_mirrors/pi/pizzaql

PizzaQL是一款现代化的开源披萨店订单管理系统，提供强大的GraphQL API支持查询、变更和订阅操作，帮助开发者快速构建披萨店管理应用。本文将详细介绍PizzaQL API的核心功能和实战示例，让你轻松掌握订单数据的增删改查全流程。

核心功能概览

PizzaQL API基于GraphQL构建，提供三大核心操作类型：

• 查询(Query): 获取订单数据，支持单订单查询和订单列表查询
• 变更(Mutation): 管理订单生命周期，包括创建、更新和删除订单
• 订阅(Subscription): 实时接收新订单通知，实现即时订单处理

PizzaQL订单管理仪表板展示了API驱动的订单数据可视化界面

API架构解析

PizzaQL的API架构在项目中通过以下文件定义：

• 数据模型定义: backend/prisma/schema.prisma
• GraphQL模式: backend/src/generated/schema.graphql
• API实现代码: backend/src/index.js

核心数据模型Order包含以下字段：

• 基本信息:id,name,phone,street,city
• 订单详情:type,size,dough,price,time
• 状态信息:status,paid

查询操作实战

获取所有订单

使用orders查询获取系统中的所有订单数据：

query { orders { id name type status price } }

获取单个订单

通过订单ID查询特定订单详情：

query { order(id: "25") { id name phone street city type size dough price status time paid } }

查询操作结果可用于构建订单列表页面和详情页面，如frontend/pages/admin.js和frontend/pages/order.js中实现的功能。

变更操作详解

创建新订单

使用createOrder变更操作添加新订单，需要提供客户信息和订单详情：

mutation { createOrder( name: "John Doe" phone: "123456789" street: "Main Street 123" city: "New York" type: "Pepperoni" size: "Large" dough: "Thick" price: "23.00 PLN" time: "6:30" status: "in progress" paid: false ) { id name status } }

订单创建表单通过API提交数据，对应createOrder变更操作

更新订单状态

通过updateOrder变更操作更新订单状态（如标记为完成或取消）：

mutation { updateOrder( id: "25" status: "completed" ) { id status } }

删除订单

使用deleteOrder变更操作移除不需要的订单：

mutation { deleteOrder(id: "24") { id name } }

这些变更操作在frontend/components/dashboard/utils/目录下的工具函数中被调用，实现了订单管理的核心功能。

订阅操作实现

PizzaQL提供createdOrder订阅操作，实时接收新订单通知：

subscription { createdOrder { id name type status time } }

订阅功能使厨房显示系统能够即时接收新订单，大大提高订单处理效率。

实际应用场景

客户下单流程

1. 客户填写订单表单(frontend/components/form/order-placement-form.js)
2. 系统调用createOrder变更操作
3. 返回订单确认信息(frontend/pages/order.js)

订单确认页面展示了createOrder操作的结果

餐厅管理流程

1. 管理员查看订单列表(frontend/components/dashboard/orders.js)
2. 更新订单状态（完成/取消）
3. 系统实时更新订单状态

快速开始使用

要开始使用PizzaQL API，首先克隆仓库：

git clone https://gitcode.com/gh_mirrors/pi/pizzaql

然后按照项目文档设置后端服务，即可通过GraphQL Playground或客户端应用调用API。

PizzaQL API设计简洁而强大，通过直观的GraphQL接口简化了披萨店订单管理系统的开发。无论是构建客户下单界面还是餐厅管理后台，PizzaQL都能提供高效的数据交互支持。

【免费下载链接】pizzaql:pizza: Modern OSS Order Management System for Pizza Restaurants项目地址: https://gitcode.com/gh_mirrors/pi/pizzaql