ButterflyPress
Backend

Headless Wagtail & Pluggable Feature Registry

Configure /api/v1/ endpoints, OpenAPI schema generation, Wagtail Admin Live Catalog (/cms/catalog/), and modular FeatureDefinition plugins.

REST API v1 & OpenAPI 3.0

ButterflyPress exposes normalized camelCase endpoints under /api/v1/ with RFC 7807 application/problem+json errors:

  • /api/v1/pages/ & /api/v1/page-preview/ — StreamField pages and Draft Preview
  • /api/v1/sites/ — Multi-site resolution and Light/Dark ThemeSettings CSS variables
  • /api/v1/forms/ — Dynamic form schema and submission endpoint
  • /api/v1/features/ — Enabled pluggable feature manifest
  • /api/v1/schema/ — Cycle-safe recursive OpenAPI 3.0 spec

Registering a Pluggable Feature

Vertical modules contribute isolated endpoints, StreamField blocks, OpenAPI tags/schemas, and Site settings via @hooks.register("register_butterflypress_feature") or the butterflypress.features entry point group.

wagtail_hooks.py python
from wagtail import hooks
from butterflypress_features import FeatureBlockDefinition, FeatureDefinition, FeatureWagtailEndpoint

@hooks.register("register_butterflypress_feature")
def register_vertical():
    return FeatureDefinition(
        slug="locations",
        name="Locations",
        wagtail_endpoints=(FeatureWagtailEndpoint(prefix="branch-finder", viewset=BranchFinderViewSet),),
        blocks=(FeatureBlockDefinition(slug="branch_card", block=BranchCardBlock()),),
    )