Struct poem_openapi::OpenApiService

impl<T> OpenApiService<T, ()>

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

Create an OpenAPI container.

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

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

Sets the webhooks.

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

Sets the summary of the API container.

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

Sets the description of the API container.

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

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

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

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

Sets the contact information for the exposed API.

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

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

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

Add a external document object.

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

Add extra response header

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

Add extra request header

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

Sets the cookie key.

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

Create the Swagger UI endpoint.

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

Create the Swagger UI HTML

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

Create the Rapidoc endpoint.

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

Create the Rapidoc HTML

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

Create the Redoc endpoint.

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

Create the Redoc HTML

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

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

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

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

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

Returns the OAS specification file as JSON.

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

Returns the OAS specification file as YAML.

Trait Implementations§

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

type Endpoint = Box<dyn Endpoint<Output = Response> + 'static, Global>

Represents the endpoint type.

fn into_endpoint(self) -> Self::Endpoint

Converts this object into endpoint.

Auto Trait Implementations§

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<T> EndpointExt for Twhere
T: IntoEndpoint,

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

Wrap the endpoint in a Box.

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

Use middleware to transform this endpoint. Read more

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

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

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

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

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

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

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

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

Maps the request and response of this endpoint. Read more

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

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

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

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

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: Endpoint<Output = R> + Sized,

Maps the response of this endpoint. Read more

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: Endpoint<Output = R> + Sized,

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

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

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: 'static + Error + Send + Sync,
 Self: Sized,

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

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

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

Does something with each specified error type. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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