AllBeAPI is a versatile backend-as-a-service platform offering a collection of ready-to-use APIs for common development tasks. It aims to simplify backend development by providing microservices for functionalities ranging from text processing and code formatting to image manipulation and QR code generation. Integrate these services seamlessly into your applications using our provided SDKs (JavaScript and Python) or by directly calling the REST APIs.
- Comprehensive API Suite: Access a wide range of backend tools through a unified platform.
- Easy Integration: Official SDKs for JavaScript and Python for quick setup.
- RESTful Access: Direct HTTP access to all services for flexibility.
- Open Source: Community-driven and open for contributions.
- Scalable Microservices: Each functionality is a distinct service.
AllBeAPI operates on a microservice architecture. Client applications can interact with these services either through the dedicated SDKs (JavaScript/Python) which abstract the API calls, or by making direct HTTP requests to the respective service endpoints.
Client Applications
│
├─── SDKs (JavaScript, Python) ─────┐
│ │
└─── Direct HTTP/REST API Calls ───┐ │
│ │
▼ ▼
AllBeAPI Gateway
(https://res.allbeapi.top)
│
┌────────────────────────┼────────────────────────┐
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────┐
│ Marked Service │ │ Pillow Service│ │ Prettier Service│ │ ... (Other│
│ (Markdown Proc.)│ │ (Image Proc.) │ │ (Code Format) │ │ Services) │
└─────────────────┘ └─────────────────┘ └─────────────────┘ └─────────────┘
AllBeAPI provides the following services:
- Marked: Converts Markdown text to HTML.
- BeautifulSoup: Parses and extracts data from HTML/XML.
- Prettier: Formats code for various languages (JavaScript, TypeScript, HTML, CSS, JSON, PHP, XML, Java, SQL).
- Pygments: Provides syntax highlighting for a wide range of languages.
- PythonQRCode: Generates QR codes from text or data.
- SanitizeHtml: Cleans and sanitizes HTML input to prevent XSS attacks.
- Ajv: Validates JSON data against JSON schemas.
- ESLint: Lints JavaScript and TypeScript code to find and fix problems.
- Diff: Compares text and highlights differences.
- CsvParser: Parses CSV data.
- MermaidCli: Generates diagrams and flowcharts from text using Mermaid syntax.
- PDFKit: Creates and manipulates PDF documents.
- Pillow: Performs various image processing tasks (resize, filters, format conversion, etc.).
You can interact with AllBeAPI services using our SDKs or by making direct HTTP requests. The base URL for all API services is https://res.allbeapi.top.
Installation:
Download the SDK file:
curl -O https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/JavaScript/allbeapi.js
# Or use wget
wget https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/JavaScript/allbeapi.jsOr include it via CDN:
<script src="https://cdn.jsdelivr.net/gh/TingjiaInFuture/allbeapi@3/SDK/JavaScript/allbeapi.js"></script>Usage:
// If using Node.js:
// const AllBeApi = require('./allbeapi.js'); // Assuming the SDK file is in the same directory
// In the browser (after including the script tag):
const api = new AllBeApi();
async function exampleUsage() {
try {
// Convert Markdown to HTML
const markdownText = "# Hello AllBeAPI\nThis is **awesome**!";
const htmlResult = await api.marked.render(markdownText);
console.log('HTML Output:', htmlResult);
// Generate a QR code
const qrBlob = await api.pythonQrcode.generateQrcode("https://allbeapi.top");
// You can then use this blob to display the QR code, e.g., by creating an object URL
const qrImageUrl = URL.createObjectURL(qrBlob);
console.log('QR Code Image URL:', qrImageUrl);
// Example: <img src="qrImageUrl" alt="QR Code">
} catch (error) {
console.error("API Error:", error);
}
}
exampleUsage();Installation:
Download the SDK file:
curl -O https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/Python/allbeapi.py
# Or use wget
wget https://raw.githubusercontent.com/TingjiaInFuture/allbeapi/main/SDK/Python/allbeapi.pyUsage:
# Ensure allbeapi.py is in your Python path or the same directory
from allbeapi import AllBeApi
api = AllBeApi()
def example_usage():
try:
# Convert Markdown to HTML
markdown_text = "# Hello AllBeAPI\nThis is **awesome**!"
html_result = api.marked.render(markdown_text)
print(f"HTML Output: {html_result}")
# Generate a QR code
# The Python SDK's generate_qrcode returns bytes of the image
qr_image_bytes = api.python_qrcode.generate_qrcode(data="https://allbeapi.top", image_format="png")
# You can save these bytes to a file
with open("qrcode.png", "wb") as f:
f.write(qr_image_bytes)
print("QR Code saved to qrcode.png")
except Exception as e:
print(f"API Error: {e}")
if __name__ == '__main__':
example_usage()You can also make direct HTTP requests to the API endpoints. For example, to convert Markdown using curl:
curl -X POST https://res.allbeapi.top/marked/render \
-H "Content-Type: application/json" \
-d '{ "markdown": "# Hello via cURL" }'- General Documentation: docs/index.html
- API Reference: docs/api.html (Details all endpoints, parameters, and response formats)
- SDK Guide: docs/sdk.html
- Getting Started Guide: docs/getting-started.html
Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to:
- Fork the repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
We value community contributions and look forward to your input!
This project is licensed under the MIT License - see the LICENSE file for details.
For issues, feature requests, or questions, please open an issue on the GitHub repository.