Tandoor 餐厅管理系统 API 文档

介绍

Tandoor 餐厅管理系统提供了一套全面的 API 接口，用于管理餐厅的日常运营，包括菜单、订单、库存和员工等各个方面。本文档详细介绍了各个 API 接口的功能、参数以及使用方法。

安装与配置

安装依赖

确保你已经安装了 Node.js 和 npm。然后运行以下命令安装所需的依赖：

npm install express axios cors dotenv

配置环境变量

创建一个 .env 文件，并添加你的 Tandoor API 令牌：

TANDOOR_API_TOKEN=your-api-token

基础接口

获取菜单

获取餐厅的当前菜单。

请求方法

GET

请求路径

/api/menu

查询参数

无

返回格式

JSON

示例响应

{
  "menuItems": [
    {
      "id": 1,
      "name": "Margherita Pizza",
      "price": 12.99,
      "description": "Classic Italian pizza with tomatoes, mozzarella and basil.",
      "category": "Pizza"
    },
    // 更多菜品...
  ]
}

创建新订单

创建一个新的餐厅订单。

请求方法

POST

请求路径

/api/order

请求参数

{
  "orderItems": [
    {
      "foodId": number,
      "quantity": number,
      "price": number
    },
    // 更多菜品...
  ],
  "customerId": number,
  "totalAmount": number,
  "paymentMethod": string
}

返回格式

JSON

示例响应

{
  "orderId": 123,
  "orderStatus": "pending",
  "createdAt": "2023-10-01T15:30:00Z"
}

更新库存

更新餐厅的库存信息。

请求方法

PUT

请求路径

/api/inventory

请求参数

{
  "foodId": number,
  "newQuantity": number
}

返回格式

JSON

示例响应

{
  "message": "Inventory updated successfully",
  "updatedFood": {
    "id": 5,
    "name": "Tomatoes",
    "quantity": 150
  }
}

高级功能

获取员工列表

获取餐厅的所有员工信息。

请求方法

GET

请求路径

/api/employees

查询参数

无

返回格式

JSON

示例响应

{
  "employeeList": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "role": "Chef"
    },
    // 更多员工...
  ]
}

更新员工信息

更新指定员工的信息。

请求方法

PUT

请求路径

/api/employees/:id

请求参数

{
  "firstName": string,
  "lastName": string,
  "role": string
}

返回格式

JSON

示例响应

{
  "message": "Employee updated successfully",
  "employee": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "role": "Head Chef"
  }
}

错误处理

错误码

• 400 Bad Request: 请求参数错误或缺失。
• 401 Unauthorized: 未授权访问。
• 404 Not Found: 资源不存在。
• 500 Internal Server Error: 服务器内部错误。

示例错误响应

{
  "error": {
    "code": 400,
    "message": "Missing required parameter 'customerId'"
  }
}

测试

我们提供了一个测试脚本，用于验证服务器功能是否正常运行：

npm run test

测试脚本提供了以下功能：

1. 列出所有可用的 API 接口。
2. 测试创建新订单。
3. 测试更新库存。

故障排除

如果在使用过程中遇到问题，请按照以下步骤排查：

1. 确保服务器已正确启动并显示 [Setup] Tandoor Management System server running on stdio.。
2. 检查你的 Tandoor API 令牌是否正确配置。
3. 查看终端中的错误信息，获取更多调试线索。
4. 使用测试脚本验证服务器功能，排除 MCP 系统的问题。

通过以上文档，你可以全面了解和使用 Tandoor 餐厅管理系统的各项功能。