APIFromAnything Documentation

Transform any Python function into a production-ready REST API endpoint in seconds

Welcome to the official documentation for APIFromAnything, a powerful Python library designed to transform ordinary Python functions into fully-functional REST API endpoints using a decorator-based approach.

Version 1.0.0 - Production Ready

APIFromAnything is now production-ready with version 1.0.0! This release includes:

Comprehensive test suite with high code coverage
Production-grade security features
Performance optimizations for high-traffic scenarios
Detailed documentation and examples
Support for multiple deployment environments
Full async/await support throughout the codebase

Overview

APIFromAnything is designed to be robust, extensible, and high-performance, with features like automatic routing, input validation, output serialization, error handling, and documentation generation. It’s perfect for quickly creating APIs from existing code, building microservices, or developing serverless functions.

from apifrom import API, api

app = API(title="My API")

@api(route="/hello/{name}")
def hello(name: str, greeting: str = "Hello") -> dict:
    """Say hello to someone."""
    return {"message": f"{greeting}, {name}!"}

# That's it! You now have a fully functioning API endpoint

Key Features

🧩 Simple Decorator API: Transform any Python function into an API endpoint with a single decorator
🔍 Type-Based Validation: Automatic request validation based on Python type hints
🔄 Automatic Serialization: Convert Python objects to JSON responses automatically
🛣️ Path & Query Parameters: Support for path and query parameters with automatic type conversion
⚡ Asynchronous Support: First-class support for async/await functions
🔌 Middleware System: Extensible middleware system for request/response processing
🔒 Security Features: Built-in support for JWT, API key, Basic auth, OAuth2, CORS, CSRF, security headers, and more
📚 OpenAPI Documentation: Automatic generation of OpenAPI/Swagger documentation
📊 Monitoring & Metrics: Track API performance and usage with comprehensive metrics collection
🚀 Performance Optimization: Tools for profiling, caching, connection pooling, and batch processing
☁️ Serverless Ready: Deploy to AWS Lambda, Google Cloud Functions, Azure Functions, Vercel, and Netlify
🔌 Plugin System: Extend and customize functionality with a powerful plugin architecture

Documentation Structure

This documentation is organized into the following sections:

Getting Started: Quick start guide and basic concepts
Core Concepts: Detailed explanation of the core concepts and components
API Reference: Comprehensive reference for all modules and functions
Middleware: Guide to using and creating middleware components
Security: Detailed information about security features
Performance: Performance optimization techniques
Plugins: Guide to using and creating plugins
Advanced Caching: Advanced caching strategies
Serverless: Deploying to serverless environments
Deployment: General deployment guidelines
Testing: Testing your APIs
Troubleshooting: Common issues and solutions
Contributing: Guidelines for contributing to the project
Examples: Comprehensive examples demonstrating various features

Installation

# Basic installation
pip install apifrom

# With all optional dependencies
pip install "apifrom[all]"

Quick Links

License

APIFromAnything is licensed under the MIT License. See the LICENSE file for details.

Contents: