Umbral Playground
Official by Umbral contributorsin-app API console, OpenAPI discovery, auth, history
About
A mini-Postman baked right into your app. Umbral Playground lets anyone browse your REST resources, build a request, send it, and read the response — no external tool, no copy-pasting curl commands into a terminal. It's the fastest way to hand an API to a frontend teammate: point them at a URL and they're exploring live endpoints in seconds, against the real running server.
Install
Wire it up
Give it a title and the path to mount at.
use *;
use PlaygroundPlugin;
let app = builder
.database
.plugin
.plugin
.plugin
.build?;
Target: onboard a frontend dev in one link
Instead of maintaining a Postman collection, send the playground URL — it discovers resources from the running server, so it's never stale.
What you get
- Browse resources, build and send requests in the browser
- Read live responses against the real server
- Auth auto-detected from the published OpenAPI securitySchemes
- Mount anywhere with
.at("/path/") - Zero external tooling to install or keep in sync
Usage
Mount `PlaygroundPlugin::new(title).at("/path/")` alongside umbral-rest and umbral-openapi — it discovers resources from the running server and auto-detects auth from the published securitySchemes, so the console is never out of date.
cargo add umbral-playground
Feature tracker
Per-feature shipping status, recorded in the directory.
Reads the running app schema to list resources and operations.
Edit method, path, headers, query params, and JSON body.
Formatted status, headers, body, and timing for live calls.
Bearer-token input informed by OpenAPI security schemes.
Local browser history for replaying recent API calls.
Persist and restore playground settings and request state.
Compatibility
Declared support per Umbral version and database backend.
No compatibility rows declared yet.
Community notes
0 notes in the discussion thread.
No notes yet. Be the first to share how this plugin works for you.
Reported issues
Bugs and abuse reports filed against this plugin.
No open issues
No issues have been reported against this plugin. Track upstream bugs on the maintainer's tracker, or report a directory problem to the Umbral team.