Struct OpenApiPlugin 

pub struct OpenApiPlugin { /* private fields */ }

The OpenAPI plugin.

Implementations

impl OpenApiPlugin

pub fn new() -> Self

pub fn at(self, path: &str) -> Self

Mount the JSON + UI under a different base. Trailing slashes are normalised so both .at("/api/docs") and .at("/api/docs/") register the same routes.

pub fn title(self, s: impl Into<String>) -> Self

Override info.title in the emitted spec.

pub fn version(self, s: impl Into<String>) -> Self

Override info.version in the emitted spec.

pub fn description(self, s: impl Into<String>) -> Self

Set info.description in the emitted spec. Optional — omitted from the JSON when unset. Markdown is permitted (per OpenAPI 3.0.3); Swagger UI renders it above the operations list, so this is the place to document API-wide auth, rate limiting, conventions, etc.

pub fn exclude<I, S>(self, tables: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add tables to the block-list. The umbral-rest defaults still apply.

Trait Implementations

impl Clone for OpenApiPlugin

fn clone(&self) -> OpenApiPlugin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for OpenApiPlugin

fn name(&self) -> &'static str

A stable identifier. Used as the key in the migration tracking table, in dependency lists, and as the directory name under migrations/. Plugin names live in the same namespace as migrate::APP_PLUGIN_NAME ("app"), so user crates must not pick the name "app".

fn dependencies(&self) -> &'static [&'static str]

Names of plugins that must load before this one. The App::builder() topological sort uses this; cycles surface as BuildError::PluginCycle. The default is no dependencies.

fn routes(&self) -> Router

The plugin’s HTTP routes. Merged into the app router after the hand-written one passed to AppBuilder::routes(). Plugins choose their own path prefixes (spec 02 §“What a plugin can contribute”: routes are flat, not auto-prefixed).

fn models(&self) -> Vec<ModelMeta>

The plugin’s models, in declaration order. The M7 migration engine collects these across every registered plugin and uses them as the diff target for makemigrations.

fn route_paths(&self) -> Vec<RouteSpec>

Declared URL routes this plugin contributes — a companion to routes used for surfacing route lists outside the request flow (currently: the dev-mode default 404 page). axum doesn’t expose its internal route table, so plugins report what they declare here; the framework treats this as informational only — not a source of truth for routing.

fn openapi_paths(&self) -> Vec<(String, Value)>

OpenAPI path items the plugin contributes. Returned as a Vec<(path, value)> where path is the URL template (/api/auth/login, /api/foo/{id}) and value is the matching OpenAPI 3.0 Path Item Object serialised as a serde_json::Value.

fn system_checks(&self) -> Vec<SystemCheck>

Boot-time checks the plugin needs to pass. Run in phase 4 of App::build() alongside the framework’s built-in checks. Severity::Error blocks boot; Severity::Warning logs and continues.

fn provides_storage(&self) -> bool

true if this plugin registers a Storage backend (e.g. StoragePlugin, which calls crate::storage::set_storage in Plugin::on_ready).

fn database(&self) -> Option<&'static str>

The database alias every model this plugin contributes should be read from and written to. Returns None to use the "default" pool (the same one umbral::db::pool() returns).

fn templates_dirs(&self) -> Vec<PathBuf>

Template directories this plugin contributes.

fn template_registrars( &self, ) -> Vec<Box<dyn Fn(&mut Environment<'static>) + Sync + Send>>

Custom template tags / filters this plugin contributes (feature #67 — Django’s {% load %}-able template library).

fn wrap_router(&self, router: Router) -> Router

Wrap the app router with the plugin’s middleware layers.

fn middleware(&self) -> Vec<Arc<dyn Middleware>>

Framework-level request/response middleware this plugin contributes (feature #68).

fn static_files(&self) -> Vec<StaticFile>

Static files the plugin ships baked into its binary.

fn static_dirs(&self) -> Vec<StaticDir>

On-disk source directories this plugin contributes to the unified static pipeline.

fn static_root_dirs(&self) -> Vec<PathBuf>

On-disk directories served at the root of static_url — with no namespace segment.

fn commands(&self) -> Vec<Box<dyn PluginCommand>>

CLI subcommands the plugin contributes.

fn api_endpoints(&self) -> Vec<ApiEndpoint>

Callable HTTP endpoints this plugin wants advertised in a machine-readable index (e.g. a REST API root, or a client’s service-discovery fetch).

fn on_ready( &self, _ctx: &AppContext, ) -> Result<(), Box<dyn Error + Sync + Send>>

Wire signals, start background work, seal admin registrations. Called after phase 4 (system checks) passes, in topological dependency order. Sync, on purpose; spawn async work via ctx.runtime() when the runtime handle lands.