Struct OpenapiInitializerWithSetup

pub struct OpenapiInitializerWithSetup { /* private fields */ }

Loco initializer for OpenAPI with custom initial spec setup

Implementations

impl OpenapiInitializerWithSetup

pub fn new<F>( initial_spec: F, routes_setup: Option<Vec<OpenApiRouter<AppContext>>>, ) -> Self

where F: Fn(&AppContext) -> OpenApi + Send + Sync + 'static,

Trait Implementations

impl Default for OpenapiInitializerWithSetup

fn default() -> OpenapiInitializerWithSetup

Returns the “default value” for a type.

impl Initializer for OpenapiInitializerWithSetup

fn name(&self) -> String

The initializer name or identifier

fn after_routes<'life0, 'life1, 'async_trait>( &'life0 self, router: AxumRouter, ctx: &'life1 AppContext, ) -> Pin<Box<dyn Future<Output = Result<AxumRouter>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Occurs after the app’s after_routes. Use this to compose additional functionality and wire it into an Axum Router

fn before_run<'life0, 'life1, 'async_trait>( &'life0 self, _app_context: &'life1 AppContext, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Occurs after the app’s before_run. Use this to for one-time initializations, load caches, perform web hooks, etc.

fn check<'life0, 'life1, 'async_trait>( &'life0 self, _app_context: &'life1 AppContext, ) -> Pin<Box<dyn Future<Output = Result<Option<Check>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Perform health checks for this initializer. This method is called during the doctor command to validate the initializer’s configuration. Return None if no check is needed, or Some(Check) if a check should be performed.