Pocket API

Zero-boilerplate REST API framework for Python.

Turn any Python file into a live REST API with auto-generated Swagger documentation. Just write functions — Pocket API handles the rest.

Installation

pip install pocketapi

Quick Start

Create a Python file with your functions:

# api.py
def hello(name: str = "World"):
    """Say hello to someone."""
    return {"greeting": f"Hello, {name}!"}

def add(a: int, b: int):
    """Add two integers."""
    return {"sum": a + b}

Then serve it:

pocketapi serve api.py

Now visit:

• API: http://localhost:8000/
• Docs: http://localhost:8000/docs

Test your endpoints:

curl "http://localhost:8000/hello?name=Alice"
# {"greeting": "Hello, Alice!"}

curl "http://localhost:8000/add?a=10&b=20"
# {"sum": 30}

Features

• Zero boilerplate — functions become endpoints automatically
• Type coercion — type hints auto-cast query parameters
• Swagger UI — interactive docs at /docs
• OpenAPI 3.0 — machine-readable spec at /openapi.json
• Error handling — missing params return 400, server errors return 500

License

MIT