Skip to main content

RestApiCapability

Trait RestApiCapability 

Source
pub trait RestApiCapability: Send + Sync {
    // Required method
    fn register_rest(
        &self,
        ctx: &GearCtx,
        router: Router,
        openapi: &dyn OpenApiRegistry,
    ) -> Result<Router>;
}
Expand description

REST API capability: Pure wiring; must be sync. Runs AFTER DB migrations.

Required Methods§

Source

fn register_rest( &self, ctx: &GearCtx, router: Router, openapi: &dyn OpenApiRegistry, ) -> Result<Router>

Register REST routes for this gear.

§Errors

Returns an error if route registration fails.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§