Skip to main content

OpenApiRouter

platform_http

Struct OpenApiRouter 

Source 
pub struct OpenApiRouter<S = ()>(/* private fields */);
Expand description

A wrapper struct for axum::Router and utoipa::openapi::OpenApi for composing handlers and services with collecting OpenAPI information from the handlers.

This struct provides pass through implementation for most of the axum::Router methods and extends capabilities for few to collect the OpenAPI information. Methods that are not implemented can be easily called after converting this router to axum::Router by Into::into.

§Examples

Create new OpenApiRouter with default values populated from cargo environment variables.

let _: OpenApiRouter = OpenApiRouter::new();

Instantiate a new OpenApiRouter with new empty utoipa::openapi::OpenApi.

let _: OpenApiRouter = OpenApiRouter::default();

Implementations§

Source§

impl<S> OpenApiRouter<S>
where S: Send + Sync + Clone + 'static,

Source

pub fn new() -> OpenApiRouter<S>

Instantiate a new OpenApiRouter with default values populated from cargo environment variables. This creates an OpenApi similar of creating a new OpenApi via #[derive(OpenApi)]

If you want to create OpenApiRouter with completely empty utoipa::openapi::OpenApi instance, use OpenApiRouter::default().

Source

pub fn with_openapi(openapi: OpenApi) -> OpenApiRouter<S>

Instantiates a new OpenApiRouter with given openapi instance.

This function allows using existing utoipa::openapi::OpenApi as source for this router.

§Examples

Use derived utoipa::openapi::OpenApi as source for OpenApiRouter.

#[derive(utoipa::ToSchema)]
struct Todo {
    id: i32,
}
#[derive(utoipa::OpenApi)]
#[openapi(components(schemas(Todo)))]
struct Api;

let mut router: OpenApiRouter = OpenApiRouter::with_openapi(Api::openapi());
Source

pub fn as_service<B>(&mut self) -> RouterAsService<'_, B, S>

Pass through method for axum::Router::as_service.

Source

pub fn fallback<H, T>(self, handler: H) -> OpenApiRouter<S>
where H: Handler<T, S>, T: 'static,

Pass through method for axum::Router::fallback.

Source

pub fn fallback_service<T>(self, service: T) -> OpenApiRouter<S>
where T: Service<Request<Body>, Error = Infallible> + Clone + Send + Sync + 'static, <T as Service<Request<Body>>>::Response: IntoResponse, <T as Service<Request<Body>>>::Future: Send + 'static,

Pass through method for axum::Router::fallback_service.

Source

pub fn layer<L>(self, layer: L) -> OpenApiRouter<S>
where L: Layer<Route> + Clone + Send + Sync + 'static, <L as Layer<Route>>::Service: Service<Request<Body>> + Clone + Send + Sync + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Response: IntoResponse + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Error: Into<Infallible> + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Future: Send + 'static,

Pass through method for axum::Router::layer.

Source

pub fn routes( self, _: (Vec<(String, RefOr<Schema>)>, Paths, MethodRouter<S>), ) -> OpenApiRouter<S>

Register UtoipaMethodRouter content created with routes macro to self.

Paths of the UtoipaMethodRouter will be extended to utoipa::openapi::OpenApi and axum::routing::MethodRouter will be added to the axum::Router.

Source

pub fn route( self, path: &str, method_router: MethodRouter<S>, ) -> OpenApiRouter<S>

Pass through method for axum::Router<S>::route.

Source

pub fn route_layer<L>(self, layer: L) -> OpenApiRouter<S>
where L: Layer<Route> + Clone + Send + Sync + 'static, <L as Layer<Route>>::Service: Service<Request<Body>> + Clone + Send + Sync + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Response: IntoResponse + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Error: Into<Infallible> + 'static, <<L as Layer<Route>>::Service as Service<Request<Body>>>::Future: Send + 'static,

Pass through method for axum::Router::route_layer.

Source

pub fn route_service<T>(self, path: &str, service: T) -> OpenApiRouter<S>
where T: Service<Request<Body>, Error = Infallible> + Clone + Send + Sync + 'static, <T as Service<Request<Body>>>::Response: IntoResponse, <T as Service<Request<Body>>>::Future: Send + 'static,

Pass through method for axum::Router<S>::route_service.

Source

pub fn nest(self, path: &str, router: OpenApiRouter<S>) -> OpenApiRouter<S>

Nest router to self under given path. Router routes will be nested with axum::Router::nest.

This method expects OpenApiRouter instance in order to nest OpenApi paths and router routes. If you wish to use axum::Router::nest you need to first convert this instance to axum::Router (let _: Router = OpenApiRouter::new().into()).

§Examples

Nest two routers.

#[utoipa::path(get, path = "/search")]
async fn search() {}

let search_router = OpenApiRouter::new()
    .routes(utoipa_axum::routes!(search));

let router: OpenApiRouter = OpenApiRouter::new()
    .nest("/api", search_router);
Source

pub fn nest_service<T>(self, path: &str, service: T) -> OpenApiRouter<S>
where T: Service<Request<Body>, Error = Infallible> + Clone + Send + Sync + 'static, <T as Service<Request<Body>>>::Response: IntoResponse, <T as Service<Request<Body>>>::Future: Send + 'static,

Pass through method for axum::Router::nest_service. This does nothing for OpenApi paths.

Source

pub fn merge(self, router: OpenApiRouter<S>) -> OpenApiRouter<S>

Merge utoipa::openapi::path::Paths from router to self and merge Router routes and fallback with axum::Router::merge.

This method expects OpenApiRouter instance in order to merge OpenApi paths and router routes. If you wish to use axum::Router::merge you need to first convert this instance to axum::Router (let _: Router = OpenApiRouter::new().into()).

§Examples

Merge two routers.

#[utoipa::path(get, path = "/search")]
async fn search() {}

let search_router = OpenApiRouter::new()
    .routes(utoipa_axum::routes!(search));

let router: OpenApiRouter = OpenApiRouter::new()
    .merge(search_router);
Source

pub fn with_state<S2>(self, state: S) -> OpenApiRouter<S2>

Pass through method for axum::Router::with_state.

Source

pub fn into_openapi(self) -> OpenApi

Consume self returning the utoipa::openapi::OpenApi instance of the OpenApiRouter.

Source

pub fn to_openapi(&mut self) -> OpenApi

Take the utoipa::openapi::OpenApi instance without consuming the OpenApiRouter.

Source

pub fn get_openapi(&self) -> &OpenApi

Get reference to the utoipa::openapi::OpenApi instance of the router.

Source

pub fn get_openapi_mut(&mut self) -> &mut OpenApi

Get mutable reference to the utoipa::openapi::OpenApi instance of the router.

Source

pub fn split_for_parts(self) -> (Router<S>, OpenApi)

Split the content of the OpenApiRouter to parts. Method will return a tuple of inner axum::Router and utoipa::openapi::OpenApi.

Trait Implementations§

Source§

impl<S> Clone for OpenApiRouter<S>
where S: Clone,

Source§

fn clone(&self) -> OpenApiRouter<S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<S> Default for OpenApiRouter<S>
where S: Send + Sync + Clone + 'static,

Source§

fn default() -> OpenApiRouter<S>

Returns the “default value” for a type. Read more
Source§

impl<S> From<OpenApiRouter<S>> for Router<S>

Source§

fn from(value: OpenApiRouter<S>) -> Router<S>

Converts to this type from the input type.
Source§

impl<S> From<Router<S>> for OpenApiRouter<S>

Source§

fn from(value: Router<S>) -> OpenApiRouter<S>

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<S = ()> !RefUnwindSafe for OpenApiRouter<S>

§

impl<S = ()> !UnwindSafe for OpenApiRouter<S>

§

impl<S> Freeze for OpenApiRouter<S>

§

impl<S> Send for OpenApiRouter<S>

§

impl<S> Sync for OpenApiRouter<S>

§

impl<S> Unpin for OpenApiRouter<S>

§

impl<S> UnsafeUnpin for OpenApiRouter<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more