poem_openapi

Struct OpenApiService

Source 
pub struct OpenApiService<T, W> { /* private fields */ }
Expand description

An OpenAPI service for Poem.

Implementations§

Source§

impl<T> OpenApiService<T, ()>

Source

pub fn new(api: T, title: impl Into<String>, version: impl Into<String>) -> Self

Create an OpenAPI container.

Source§

impl<T, W> OpenApiService<T, W>

Source

pub fn webhooks<W2>(self) -> OpenApiService<T, W2>

Sets the webhooks.

Source

pub fn summary(self, summary: impl Into<String>) -> Self

Sets the summary of the API container.

Source

pub fn description(self, description: impl Into<String>) -> Self

Sets the description of the API container.

Source

pub fn terms_of_service(self, url: impl Into<String>) -> Self

Sets a URL to the Terms of Service for the API.

Source

pub fn server(self, server: impl Into<ServerObject>) -> Self

Appends a server to the API container.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverObject

Source

pub fn contact(self, contact: ContactObject) -> Self

Sets the contact information for the exposed API.

Source

pub fn license(self, license: impl Into<LicenseObject>) -> Self

Sets the license information for the exposed API.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object

Source

pub fn external_document( self, external_document: impl Into<ExternalDocumentObject>, ) -> Self

Add a external document object.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object

Source

pub fn extra_response_header<HT, H>(self, header: H) -> Self
where HT: Type, H: Into<ExtraHeader>,

Add extra response header

Source

pub fn extra_request_header<HT, H>(self, header: H) -> Self
where HT: Type, H: Into<ExtraHeader>,

Add extra request header

Source

pub fn cookie_key(self, key: CookieKey) -> Self

Sets the cookie key.

Source

pub fn url_prefix(self, url_prefix: impl Into<String>) -> Self

Sets optional URl prefix to be added to path

Source

pub fn openapi_explorer(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create the OpenAPI Explorer endpoint.

Source

pub fn openapi_explorer_html(&self) -> String
where T: OpenApi, W: Webhook,

Create the OpenAPI Explorer HTML

Source

pub fn swagger_ui(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create the Swagger UI endpoint.

Source

pub fn swagger_ui_html(&self) -> String
where T: OpenApi, W: Webhook,

Create the Swagger UI HTML

Source

pub fn rapidoc(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create the Rapidoc endpoint.

Source

pub fn rapidoc_html(&self) -> String
where T: OpenApi, W: Webhook,

Create the Rapidoc HTML

Source

pub fn redoc(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create the Redoc endpoint.

Source

pub fn redoc_html(&self) -> String
where T: OpenApi, W: Webhook,

Create the Redoc HTML

Source

pub fn spec_endpoint(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create an endpoint to serve the open api specification as JSON.

Source

pub fn spec_endpoint_yaml(&self) -> impl Endpoint
where T: OpenApi, W: Webhook,

Create an endpoint to serve the open api specification as YAML.

Source

pub fn spec(&self) -> String
where T: OpenApi, W: Webhook,

Returns the OAS specification file as JSON.

Source

pub fn spec_yaml(&self) -> String
where T: OpenApi, W: Webhook,

Returns the OAS specification file as YAML.

Trait Implementations§

Source§

impl<T: Clone, W: Clone> Clone for OpenApiService<T, W>

Source§

fn clone(&self) -> OpenApiService<T, W>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: OpenApi, W: Webhook> IntoEndpoint for OpenApiService<T, W>

Source§

type Endpoint = Box<dyn DynEndpoint<Output = Response>>

Represents the endpoint type.
Source§

fn into_endpoint(self) -> Self::Endpoint

Converts this object into endpoint.

Auto Trait Implementations§

§

impl<T, W> Freeze for OpenApiService<T, W>
where T: Freeze,

§

impl<T, W> RefUnwindSafe for OpenApiService<T, W>
where T: RefUnwindSafe, W: RefUnwindSafe,

§

impl<T, W> Send for OpenApiService<T, W>
where T: Send, W: Send,

§

impl<T, W> Sync for OpenApiService<T, W>
where T: Sync, W: Sync,

§

impl<T, W> Unpin for OpenApiService<T, W>
where T: Unpin, W: Unpin,

§

impl<T, W> UnwindSafe for OpenApiService<T, W>
where T: UnwindSafe, W: UnwindSafe,

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<T> CloneToUninit for T
where T: Clone,

Source§

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

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

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> EndpointExt for T
where T: IntoEndpoint,

Source§

fn boxed<'a>( self, ) -> Box<dyn DynEndpoint<Output = <Self::Endpoint as Endpoint>::Output> + 'a>
where Self: Sized + 'a,

Wrap the endpoint in a Box.
Source§

fn with<T>(self, middleware: T) -> <T as Middleware<Self::Endpoint>>::Output
where T: Middleware<Self::Endpoint>, Self: Sized,

Use middleware to transform this endpoint. Read more
Source§

fn with_if<T>( self, enable: bool, middleware: T, ) -> EitherEndpoint<Self, <T as Middleware<Self::Endpoint>>::Output>
where T: Middleware<Self::Endpoint>, Self: Sized,

if enable is true then use middleware to transform this endpoint. Read more
Source§

fn data<T>(self, data: T) -> AddDataEndpoint<Self::Endpoint, T>
where T: Clone + Send + Sync + 'static, Self: Sized,

Attach a state data to the endpoint, similar to with(AddData(T)). Read more
Source§

fn data_opt<T>( self, data: Option<T>, ) -> EitherEndpoint<AddDataEndpoint<Self::Endpoint, T>, Self>
where T: Clone + Send + Sync + 'static, Self: Sized,

if data is Some(T) then attach the value to the endpoint.
Source§

fn before<F, Fut>(self, f: F) -> Before<Self, F>
where F: Fn(Request) -> Fut + Send + Sync, Fut: Future<Output = Result<Request, Error>> + Send, Self: Sized,

Maps the request of this endpoint. Read more
Source§

fn after<F, Fut, T>(self, f: F) -> After<Self::Endpoint, F>
where F: Fn(Result<<Self::Endpoint as Endpoint>::Output, Error>) -> Fut + Send + Sync, Fut: Future<Output = Result<T, Error>> + Send, T: IntoResponse, Self: Sized,

Maps the output of this endpoint. Read more
Source§

fn around<F, Fut, R>(self, f: F) -> Around<Self::Endpoint, F>
where F: Fn(Arc<Self::Endpoint>, Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R, Error>> + Send + 'static, R: IntoResponse, Self: Sized,

Maps the request and response of this endpoint. Read more
Source§

fn map_to_response(self) -> MapToResponse<Self::Endpoint>
where Self: Sized,

Convert the output of this endpoint into a response. Response. Read more
Source§

fn to_response(self) -> ToResponse<Self::Endpoint>
where Self: Sized,

Convert the output of this endpoint into a response. Response. Read more
Source§

fn map<F, Fut, R, R2>(self, f: F) -> Map<Self::Endpoint, F>
where F: Fn(R) -> Fut + Send + Sync, Fut: Future<Output = R2> + Send, R: IntoResponse, R2: IntoResponse, Self: Sized, Self::Endpoint: Sized + Endpoint<Output = R>,

Maps the response of this endpoint. Read more
Source§

fn and_then<F, Fut, R, R2>(self, f: F) -> AndThen<Self::Endpoint, F>
where F: Fn(R) -> Fut + Send + Sync, Fut: Future<Output = Result<R2, Error>> + Send, R: IntoResponse, R2: IntoResponse, Self: Sized, Self::Endpoint: Sized + Endpoint<Output = R>,

Calls f if the result is Ok, otherwise returns the Err value of self. Read more
Source§

fn catch_all_error<F, Fut, R>(self, f: F) -> CatchAllError<Self, F, R>
where F: Fn(Error) -> Fut + Send + Sync, Fut: Future<Output = R> + Send, R: IntoResponse + Send, Self: Sized + Sync,

Catch all errors and convert it into a response. Read more
Source§

fn catch_error<F, Fut, R, ErrType>( self, f: F, ) -> CatchError<Self, F, R, ErrType>
where F: Fn(ErrType) -> Fut + Send + Sync, Fut: Future<Output = R> + Send, R: IntoResponse + Send + Sync, ErrType: Error + Send + Sync + 'static, Self: Sized,

Catch the specified type of error and convert it into a response. Read more
Source§

fn inspect_all_err<F>(self, f: F) -> InspectAllError<Self, F>
where F: Fn(&Error) + Send + Sync, Self: Sized,

Does something with each error. Read more
Source§

fn inspect_err<F, ErrType>(self, f: F) -> InspectError<Self, F, ErrType>
where F: Fn(&ErrType) + Send + Sync, ErrType: Error + Send + Sync + 'static, Self: Sized,

Does something with each specified error type. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T