快速入门 - AllBeAPI 文档

欢迎！

AllBeAPI 是一个轻量级的通用 SDK，旨在简化各种第三方库的集成。无论您是构建 Web 应用程序、自动化任务还是处理数据，AllBeAPI 都提供了一个统一的接口来简化您的开发工作流程。

提示：有关 AllBeAPI 架构和支持的库的更多详细信息，请参阅概述文档。

安装

根据您的项目需求，通过几种方式安装 AllBeAPI SDK：

JavaScript (Node.js)

直接下载 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

然后在您的项目中引用：

const AllBeApi = require('./allbeapi.js');

Python

直接下载 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

浏览器 (CDN 或本地)

对于客户端 JavaScript，您可以通过 CDN 包含 SDK，或下载并本地托管：

<!-- 通过 CDN -->
<script src="https://cdn.jsdelivr.net/gh/TingjiaInFuture/allbeapi@3/SDK/JavaScript/allbeapi.js"></script>

<!-- 或者下载并本地托管 -->
<script src="path/to/allbeapi.js"></script>

快速开始：您的第一个 API 调用

让我们通过一个简单的示例来将 Markdown 文本转换为 HTML。

1. 初始化客户端：

const { AllBeApi } = require('allbeapi'); // CommonJS
// 或者 import { AllBeApi } from 'allbeapi'; // ES Modules

const api = new AllBeApi();
// 您还可以指定自定义端点：
// const api = new AllBeApi({ baseUrl: 'https://your-custom-endpoint.com' });

2. 进行 API 调用：

async function convertMarkdown() {
    const markdown = `# 欢迎使用 AllBeAPI
这是您的**第一个** API 调用！

## 特性
- 易于使用
- 功能强大
- 开源
`;

    try {
        const result = await api.marked.render(markdown);
        console.log('成功！', result.data.html);
    } catch (error) {
        console.error('错误：', error.message);
    }
}

convertMarkdown();

1. 初始化客户端：

from allbeapi import AllBeApi

api = AllBeApi()
# 您还可以指定自定义端点：
# api = AllBeApi(base_url='https://your-custom-endpoint.com')

2. 进行 API 调用：

def convert_markdown():
    markdown = """
# 欢迎使用 AllBeAPI
这是您的**第一个** API 调用！

## 特性
- 易于使用
- 功能强大
- 开源
"""
    try:
        result = api.marked.render(markdown)
        print('成功！', result['data']['html'])
    except Exception as e:
        print(f'错误： {e}')

convert_markdown()

创建一个 HTML 文件 (例如, demo.html):

<!DOCTYPE html>
<html>
<head>
    <title>AllBeAPI 演示</title>
    <script src="https://cdn.jsdelivr.net/gh/TingjiaInFuture/allbeapi@3/SDK/JavaScript/allbeapi.js"></script>
</head>
<body>
    <h1>AllBeAPI 演示</h1>
    <textarea id="markdown" placeholder="输入 markdown..." rows="5" cols="50"># 你好 AllBeAPI
这真是 **太棒了**！</textarea>
    <br>
    <button onclick="convert()">转换为 HTML</button>
    <h3>结果：</h3>
    <div id="result" style="border: 1px solid #ccc; padding: 10px; min-height: 50px;"></div>

    <script>
        const api = new AllBeApi();
        
        async function convert() {
            const markdownInput = document.getElementById('markdown').value;
            const resultDiv = document.getElementById('result');
            try {
                const response = await api.marked.render(markdownInput);
                resultDiv.innerHTML = response.data.html;
            } catch (error) {
                resultDiv.innerText = '错误： ' + error.message;
                console.error('错误：', error);
            }
        }
    </script>
</body>
</html>

在浏览器中打开此 HTML 文件并尝试一下！

3. 预期输出 (控制台或 HTML 页面)：

<h1 id="欢迎使用allbeapi">欢迎使用 AllBeAPI</h1>
<p>这是您的<strong>第一个</strong> API 调用！</p>
<h2 id="特性">特性</h2>
<ul>
<li>易于使用</li>
<li>功能强大</li>
<li>开源</li>
</ul>

恭喜！您已成功使用 AllBeAPI 进行了第一次 API 调用。

常见示例

以下是一些演示 AllBeAPI 功能的常见用例：

博客文章处理 (JS)

将 Markdown 转换为 HTML，生成二维码并清理 HTML 以确保安全。

async function processBlogPost(markdownContent, postUrl) {
    const api = new AllBeApi();
    
    // 将 Markdown 转换为 HTML
    const htmlResult = await api.marked.render(markdownContent);
    
    // 为分享生成二维码
    // 注意：pythonQrcode.generateQrcode 返回 Blob 对象
    const qrBlob = await api.pythonQrcode.generateQrcode(postUrl); 
    
    // 清理 HTML 以确保安全
    const cleanHtmlResult = await api.sanitizeHtml.clean(htmlResult.data.html);
    
    return { 
        html: cleanHtmlResult.data.html, 
        qrCodeBlob: qrBlob // 在浏览器中：URL.createObjectURL(qrBlob)
    };
}

代码处理 (Python)

格式化代码，进行语法检查（如果适用）并添加语法高亮。

from allbeapi import AllBeApi

def process_code(code_string, language='python', parser='python'):
    api = AllBeApi()
    
    # 格式化代码
    formatted_code = api.prettier.format(code_string, parser=parser)['data']['formatted']
    
    # 如果是 JavaScript，进行语法检查
    lint_results = None
    if language == 'javascript' or parser == 'babel': # 假设 parser 'babel' 用于 JS
        lint_results = api.eslint.analyze(formatted_code)['data']
    
    # 添加语法高亮
    highlighted_code = api.pygments.highlight(formatted_code, lexer=language)['data']['highlighted']
    
    return {
        'formatted': formatted_code,
        'lint_results': lint_results,
        'highlighted': highlighted_code
    }

数据验证和解析 (JS)

根据模式验证 JSON 数据并解析 CSV 数据。

async function processData(schema, jsonData, csvData) {
    const api = new AllBeApi();
    
    // 根据模式验证 JSON
    const validationResult = await api.ajv.validate(schema, jsonData);
    
    if (!validationResult.data.valid) {
        console.error('JSON 验证错误：', validationResult.data.errors);
    }
    
    // 解析 CSV 数据
    const parsedCsvResult = await api.csvParser.parse(csvData);
    
    return { 
        validation: validationResult.data, 
        parsedCsv: parsedCsvResult.data 
    };
}

有关更多详细示例和 API 端点，请参阅 API 参考和 SDK 指南。

后续步骤

现在您已经基本了解了 AllBeAPI，接下来可以：

深入研究 API 参考以获取所有可用端点和参数的详细信息。
探索 SDK 指南以获取有关 JavaScript 和 Python SDK 的高级用法和功能。
查看 GitHub 仓库中的示例和源代码。
加入我们的社区并为项目做出贡献！

获取支持

如果您遇到任何问题或有任何疑问，请随时：

在 GitHub Issues 上报告问题。
联系我们获取支持 (如果提供了联系方式)。