Struct ApiGateway 

pub struct ApiGateway { /* private fields */ }

Main API Gateway module — owns the HTTP server (rest_host) and collects typed operation specs to emit a single OpenAPI document.

Implementations

impl ApiGateway

pub const MODULE_NAME: &'static str = "api-gateway"

impl ApiGateway

pub fn into_module(self) -> WithLifecycle<Self>

Wrap this instance into a stateful module with lifecycle configuration.

impl ApiGateway

pub fn new(config: ApiGatewayConfig) -> Self

Create a new ApiGateway instance with the given configuration

pub fn get_config(&self) -> ApiGatewayConfig

Get the current configuration (cheap clone from ArcSwap)

pub fn get_cached_config(&self) -> ApiGatewayConfig

Get cached configuration (lock-free with ArcSwap)

pub fn get_cached_router(&self) -> Arc<Router>

Get the cached router without rebuilding (useful for performance-critical paths)

pub fn rebuild_and_cache_router(&self) -> Result<()>

Force rebuild and cache of the router.

Errors

Returns an error if router building fails.

pub fn build_router(&self) -> Result<Router>

Build the HTTP router from registered routes and operations.

Errors

Returns an error if router building or middleware setup fails.

pub fn build_openapi(&self) -> Result<OpenApi>

Build OpenAPI specification from registered routes and components.

Errors

Returns an error if OpenAPI specification building fails.

Trait Implementations

impl ApiGatewayCapability for ApiGateway

fn rest_prepare(&self, _ctx: &ModuleCtx, router: Router) -> Result<Router>

Prepare a base Router (e.g., global middlewares, /healthz) and optionally touch OpenAPI meta. Do NOT start the server here.

fn rest_finalize(&self, _ctx: &ModuleCtx, router: Router) -> Result<Router>

Finalize before start: attach /openapi.json, /docs, persist the Router internally if needed. Do NOT start the server here.

fn as_registry(&self) -> &dyn OpenApiRegistry

impl Default for ApiGateway

fn default() -> Self

Returns the “default value” for a type.

impl Module for ApiGateway

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

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

impl OpenApiRegistry for ApiGateway

fn register_operation(&self, spec: &OperationSpec)

Register an API operation specification

fn ensure_schema_raw( &self, root_name: &str, schemas: Vec<(String, RefOr<Schema>)>, ) -> String

Ensure schema for a type (including transitive dependencies) is registered under components and return the canonical component name for $ref. This is a type-erased version for dyn compatibility.

fn as_any(&self) -> &dyn Any

Downcast support for accessing the concrete implementation if needed.

impl RestApiCapability for ApiGateway

fn register_rest( &self, _ctx: &ModuleCtx, router: Router, _openapi: &dyn OpenApiRegistry, ) -> Result<Router>

Register REST routes for this module.

impl Runnable for ApiGateway

fn run<'async_trait>( self: Arc<Self>, cancel: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Long-running loop. Must return when cancel is cancelled.