阿里云 Tablestore 教程：使用 Python 与 Node.js 构建高效 RESTful API

一. 阿里云 Tablestore 与 RESTful API 简介

本文将详细介绍如何使用阿里云 Tablestore 服务在 Python 或 Node.js 中构建 RESTful API。通过本文，您将学习如何创建 Tablestore 实例和表，并通过控制台、CLI 和 SDK 执行数据操作，最终实现 RESTful API 的快速构建与管理。

二. 使用 Tablestore 构建 RESTful API 的流程

下图展示了使用 Tablestore 构建 RESTful API 的基本工作流程：

三. 创建 Tablestore 实例和表

在开始之前，请确保您已激活阿里云 Tablestore 服务。以下步骤指导您通过 Tablestore 控制台创建实例和表：

1. 创建实例

1. 登录 Tablestore 控制台，点击 创建实例 按钮，填写相关信息并完成实例创建。
   

2. 创建表

2. 实例创建成功后，进入实例详情页面，点击 创建表 按钮：

   • 主键列支持 STRING、INTEGER 和 BINARY 数据类型。
   • 配置主键列，如 id 列存储整数，group 列存储字符串。
     

3. 如果需要，可启用高级设置配置更多参数（如分区键）。完成后，表格会显示在表格列表中。
   

四. 在 Tablestore 控制台中执行数据操作

通过控制台，您可以轻松对表中的数据进行插入、查询、更新和删除操作：

1. 插入数据

进入表详情页面，点击 插入数据，填写数据后保存。

2. 查询数据

支持按主键查询单行数据或按范围查询多行数据。

3. 更新数据

选择目标行后点击 更新 按钮，修改数据并保存。

4. 删除数据

支持单行或多行删除操作。

五. 使用 Tablestore CLI 执行数据操作

Tablestore CLI 提供命令行操作方式，支持多种操作系统。

1. 安装和配置 CLI

下载并解压 Tablestore CLI 工具，运行以下命令配置必要参数：

ts configure --endpoint <endpoint> --instance <instance> --id <accessKeyId> --key <accessKeySecret>

2. 基本操作示例

• 查询数据：

ts get --table <table> --pk '[{"id":1,"group":"cli"}]'

• 插入数据：

ts put --table <table> --pk '[{"id":1,"group":"cli"}]' --attr '[{"name":"message","value":"test"}]'

• 更新和删除数据命令类似，可参考 CLI 文档。

六. 使用 Node.js SDK 构建 RESTful API

Node.js SDK 可快速构建 RESTful API。

1. 安装依赖

npm install tablestore express

2. 初始化项目

创建项目文件夹并添加文件：

• ts.js：封装对 Tablestore 的操作。
• message.js：处理 API 请求。
• server.js：定义 Express 路由。

3. 运行服务器

npm run start

4. 测试 API

通过 curl 测试 API 功能，例如：

curl -X GET http://localhost:5000/api/msg

七. 使用 Python SDK 构建 RESTful API

Python SDK 同样支持快速构建 RESTful API。

1. 安装依赖

pip install tablestore flask-restful

2. 初始化项目

创建虚拟环境和项目文件夹，添加文件：

• ts.py：封装对 Tablestore 的操作。
• server.py：定义 Flask 路由。

3. 运行服务器

python server.py

4. 测试 API

通过 curl 命令测试 API，例如：

curl -X POST -H "Content-Type: application/json" -d '{"sender":"bob","message":"test"}' http://localhost:5001/api/msg/1/python

八. 常见问题及解决方案

1. Flask 服务器启动时协议包错误

某些版本的 protobuf 可能与当前安装包不兼容。解决方法：

• 降级 protobuf 到 3.19.0。
• 手动生成兼容的 pb2.py 文件。

2. API 错误修复

• OTSAUthFailed：检查 AccessKey 对、端点和实例 ID。
• 内部服务器错误：检查代码并修复逻辑错误。

3. SQL 模式下的错误

日本（东京）地区不支持 SQL 模式，启用后会返回 OTSInternalServerError 错误。

九. 结论

本文介绍了如何使用阿里云 Tablestore 通过控制台、CLI、Node.js SDK 与 Python SDK 构建 RESTful API。掌握这些方法可以帮助开发者快速搭建高效、可扩展的 API 服务。

原文链接: https://www.alibabacloud.com/blog/a-beginners-guide-to-building-restful-apis-in-python-or-node-js-using-tablestore_600043