Umbral OpenAPI

An API nobody can read is an API nobody adopts. Umbral OpenAPI reads your registered REST resources and emits an OpenAPI 3 schema — FK targets, enums, nullable and read-only fields and all — then mounts an interactive explorer so a frontend teammate can try endpoints in the browser instead of guessing from a wiki page. The docs are generated from the resources themselves, so they can't drift from the API.

Install

cargo add umbral-openapi   # depends on umbral-rest

Wire it up

Add it after RestPlugin; it introspects whatever resources REST registered.

use umbral::prelude::*;
use umbral_rest::RestPlugin;
use umbral_openapi::OpenApiPlugin;

let app = App::builder()
    .database("default", pool)
    .plugin(RestPlugin::default().resource(/* ... */))
    .plugin(OpenApiPlugin::new())
    .build()?;

The generated spec is served for tooling, and the Swagger explorer mounts alongside it.

Target: share a live API with a frontend dev

Point them at the explorer — they get every route, its parameters, and a "try it" button, no Postman collection to maintain.

What you get

• OpenAPI 3 schema generated from registered resources
• FK targets, enums, and nullable / read-only surfaced in the schema
• Interactive Swagger UI for click-to-try requests
• securitySchemes published so the playground can auto-detect auth
• Pairs with umbral-playground for an in-app request console