Struct Scope

pub struct Scope<T>(/* private fields */);

Wrapper type for actix_web::Scope and utoipa::openapi::OpenApi with additional path prefix created with scope::scope("path-prefix") call.

See usage from scope.

Implementations

impl<T> Scope<T>

where T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,

pub fn guard<G: Guard + 'static>(self, guard: G) -> Self

Passthrough implementation for actix_web::Scope::guard.

pub fn app_data<U: 'static>(self, data: U) -> Self

Passthrough implementation for actix_web::Scope::app_data.

pub fn wrap<M, B>( self, middleware: M, ) -> Scope<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>

where M: Transform<T::Service, ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static, B: MessageBody,

Passthrough implementation for actix_web::Scope::wrap.

pub fn configure<F>(self, cfg_fn: F) -> Self

where F: FnOnce(&mut ServiceConfig<'_>),

Synonymous for UtoipaApp::configure

pub fn service<F>(self, factory: F) -> Self

where F: HttpServiceFactory + OpenApiFactory + 'static,

Synonymous for UtoipaApp::service

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

Passthrough implementation for actix_web::Scope::route.

pub fn default_service<F, U>(self, f: F) -> Self

where F: IntoServiceFactory<U, ServiceRequest>, U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error> + 'static, U::InitError: Debug,

Passthrough implementation for actix_web::Scope::default_service.

pub fn map<F: FnOnce(Scope<T>) -> Scope<NF>, NF: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>>( self, op: F, ) -> Scope<NF>

Synonymous for UtoipaApp::map

Trait Implementations

impl<'s, T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>> From<&'s str> for Scope<T>

where Scope<T>: From<Scope>,

fn from(value: &'s str) -> Self

Converts to this type from the input type.

impl<T> From<Scope<T>> for Scope<T>

where T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,

fn from(value: Scope<T>) -> Self

Converts to this type from the input type.

impl<T, B> HttpServiceFactory for Scope<T>

where T: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static, B: MessageBody + 'static,

fn register(self, config: &mut AppService)

impl<T> OpenApiFactory for Scope<T>

fn paths(&self) -> Paths

Get OpenAPI paths.

fn schemas(&self, schemas: &mut Vec<(String, RefOr<Schema>)>)

Collect schema reference and append them to the schemas.