SDK 指南
本指南将帮助您开始使用 AllBeAPI 提供的各种 SDK，包括 JavaScript、Python 以及如何直接与 REST API 交互。
JavaScript SDK
AllBeAPI JavaScript SDK 使得在您的 Web 项目中集成 AllBeAPI 服务变得简单。它提供了一种便捷的方式来与各种 API 端点进行交互。
安装
直接下载 JavaScript SDK 文件并在您的项目中使用：
# 下载 JavaScript SDK curl -O https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/JavaScript/allbeapi.js # 或使用 wget wget https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/JavaScript/allbeapi.js # 也可以直接在 HTML 中通过 CDN 引入 <script src="https://cdn.jsdelivr.net/gh/TingjiaInFuture/allbeapi@3/SDK/JavaScript/allbeapi.js"></script>
初始化
在您的 JavaScript 代码中初始化客户端：
// 如果下载了文件到本地 (Node.js)
const AllBeApi = require('./allbeapi.js');
// 或者在浏览器中通过 CDN/本地文件引入后
// const api = new AllBeApi();
const api = new AllBeApi({ base_url: 'http://localhost:3000' }); // 根据您的网关地址配置
使用示例
以下是如何使用 JavaScript SDK 将 Markdown 转换为 HTML 的示例：
async function convertMarkdown() {
const markdownText = "# 你好 AllBeAPI
这是一个 **Markdown** 文本。";
try {
const html = await api.marked.render(markdownText);
console.log(html);
// 在您的页面上显示 HTML
document.getElementById('content').innerHTML = html;
} catch (error) {
console.error("转换 Markdown 出错:", error);
}
}
convertMarkdown();
有关可用方法和选项的更多详细信息，请参阅 API 参考。
Python SDK
Python SDK 为 Python 开发者提供了一个与 AllBeAPI 服务交互的便捷方式。
安装
直接下载 Python SDK 文件并在您的项目中使用：
# 下载 Python SDK curl -O https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/Python/allbeapi.py # 或使用 wget wget https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/Python/allbeapi.py
初始化
在您的 Python 脚本中初始化客户端：
from allbeapi import AllBeApi api = AllBeApi(base_url='http://localhost:3000') # 根据您的网关地址配置
使用示例
以下是如何使用 Python SDK 生成二维码的示例：
from allbeapi import AllBeApi
api = AllBeApi(base_url='http://localhost:3000')
def generate_qr_code_example():
data_to_encode = "https://allbeapi.com"
try:
# 注意：根据实际 SDK 的方法名调整
# 假设方法是 api.python_qrcode.generate_qrcode
# 或者 api.services['python-qrcode'].generate_qrcode
qr_image_bytes = api.python_qrcode.generate_qrcode(data_to_encode)
with open("my_qrcode.png", "wb") as f:
f.write(qr_image_bytes)
print("二维码已保存为 my_qrcode.png")
except Exception as e:
print(f"生成二维码出错: {e}")
generate_qr_code_example()
有关可用方法和选项的更多详细信息，请参阅 API 参考。
REST API
如果您不使用 JavaScript 或 Python，或者更喜欢直接进行 HTTP 请求，您可以直接与 AllBeAPI 的 REST API 端点交互。
每个服务（如 Marked、BeautifulSoup 等）都有其自己的 API 端点。通常，这些是 POST 请求，其中请求体包含特定于服务的数据。
通用请求结构
- 方法： 通常是
POST - URL：
{AllBeAPI 网关地址}/{服务名称}/{端点}(例如:http://localhost:3000/marked/render) - 头部：
Content-Type: application/json(对于大多数服务) - 请求体： JSON 对象，包含服务所需的参数。
示例：使用 cURL 调用 Marked 服务
curl -X POST \
http://localhost:3000/marked/render \
-H 'Content-Type: application/json' \
-d '{
"text": "# 你好 REST API
这是通过 cURL 发送的 **Markdown**。"
}'
响应
API 将返回一个 JSON 响应。成功的响应通常包含一个 data 字段，其中包含结果。错误的响应将包含一个 error 字段。
// 成功响应示例 (Marked)
{
"data": "<h1 id="你好-rest-api">你好 REST API</h1>
<p>这是通过 cURL 发送的 <strong>Markdown</strong>。</p>
"
}
// 错误响应示例
{
"error": "请求体中缺少 'text' 字段"
}
有关每个服务的具体端点、请求参数和响应格式，请参阅 API 参考。