Struct App

pub struct App<T> { /* private fields */ }

Wrapper for actix_web::App.

Implementations

impl<T> App<T>

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

pub fn data_factory<F, Out, D, E>(self, data: F) -> Self

where F: Fn() -> Out + 'static, Out: Future<Output = Result<D, E>> + 'static, D: 'static, E: Debug,

Proxy for actix_web::App::data_factory.

NOTE: This doesn’t affect spec generation.

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

Proxy for actix_web::App::app_data.

NOTE: This doesn’t affect spec generation.

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

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

Wrapper for actix_web::App::configure.

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

Wrapper for actix_web::App::route.

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

where F: Mountable + HttpServiceFactory + 'static,

Wrapper for actix_web::App::service.

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

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

Proxy for actix_web::App::default_service.

NOTE: This doesn’t affect spec generation.

pub fn external_resource<N, U>(self, name: N, url: U) -> Self

where N: AsRef<str>, U: AsRef<str>,

Proxy for actix_web::App::external_resource.

NOTE: This doesn’t affect spec generation.

pub fn wrap<M, B>( self, mw: M, ) -> App<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,

Proxy for actix_web::web::App::wrap.

NOTE: This doesn’t affect spec generation.

pub fn wrap_fn<F, R, B>( self, mw: F, ) -> App<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>

where F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static, R: Future<Output = Result<ServiceResponse<B>, Error>>, B: MessageBody,

Proxy for actix_web::web::App::wrap_fn.

NOTE: This doesn’t affect spec generation.

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

Mounts the specification for all operations and definitions recorded by the wrapper and serves them in the given path as a JSON.

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

Converts the generated v2 specification to v3 and then mounts the v3 specification for all operations and definitions recorded by the wrapper and serves them in the given path as a JSON.

pub fn with_raw_json_spec<F>(self, call: F) -> Self

where F: FnMut(Self, Value) -> Self,

Calls the given function with App and JSON Value representing your API specification built until now.

NOTE: Unlike with_json_spec_at, this only has the API spec built until this function call. Any route handler added after this call won’t affect the spec. So, it’s important to call this function after adding all route handlers.

pub fn with_raw_json_spec_v3<F>(self, call: F) -> Self

where F: FnMut(Self, Value) -> Self,

Calls the given function with App and JSON Value representing your API v2 specification built until now which is converted to v3.

NOTE: Unlike with_json_spec_at, this only has the API spec built until this function call. Any route handler added after this call won’t affect the spec. So, it’s important to call this function after adding all route handlers.

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

Exposes the previously built JSON specification with Swagger UI at the given path

NOTE: you MUST call with_json_spec_at before calling this function

pub fn build(self) -> App<T>

Builds and returns the actix_web::App.

pub fn trim_base_path(self) -> Self

Trim’s the Api base path from the start of all method paths. NOTE: much like with_raw_json_spec this only has the API spec built until this function call. Any route handler added after this call won’t have the base path trimmed. So, it’s important to call this function after adding all route handlers.