OpenAPI Spec Generator

OpenAPI Spec Generator

Generate OpenAPI 3.0 specifications from Python function signatures and docstrings. Zero dependencies.

Part of the API Launchpad toolkit by [CodeVault](https://codevault.dev).

Features

• Function introspection: extracts parameters from type hints and signatures
• Docstring parsing: Google-style docstrings → parameter descriptions
• Type mapping: Python types → JSON Schema (str, int, float, bool, list, dict)
• Module scanning: auto-discover endpoints from function naming conventions
• Dual output: JSON or YAML (built-in YAML converter, no PyYAML needed)
• Request body inference: POST/PUT/PATCH functions automatically get request body schemas
• Zero dependencies — runs on Python stdlib only

Quick Start

# Generate a demo spec
python3 src/main.py --demo

# Generate spec from a Python module
python3 src/main.py --module my_api.py --title "My API" --output spec.json

# Output as YAML
python3 src/main.py --module my_api.py --format yaml --output spec.yaml

Using as a Library

from main import OpenAPIGenerator

gen = OpenAPIGenerator(
    title="Acme Corp API",
    version="2.0.0",
    description="The Acme Corp public API",
    server_url="https://api.docs.example.com/v2",
)

# Register endpoints from your functions
def list_users(limit: int = 10, offset: int = 0) -> list:
    """List all users with pagination.

    Args:
        limit: Maximum number of users to return
        offset: Number of users to skip
    """
    pass

def create_user(name: str, email: str, role: str = "user") -> dict:
    """Create a new user account.

    Args:
        name: User's full name
        email: User's email address
        role: User role (user, admin)
    """
    pass

*... continues with setup instructions, usage examples, and more.*