Trait poem_openapi::Response

pub trait Response: IntoResponse + Sized {
    const BAD_REQUEST_HANDLER: bool;

    fn meta() -> MetaResponses;
    fn register(registry: &mut Registry);

    fn from_parse_request_error(err: ParseRequestError) -> Self { ... }
}

Represents a OpenAPI responses object.

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

Associated Constants

const BAD_REQUEST_HANDLER: bool

If true, it means that the response object has a custom bad request handler.

Required methods

fn meta() -> MetaResponses

Gets metadata of this response.

fn register(registry: &mut Registry)

Register the schema contained in this response object to the registry.

Provided methods

fn from_parse_request_error(err: ParseRequestError) -> Self

Convert ParseRequestError to this response object.

Implementations on Foreign Types

impl Response for ()

fn meta() -> MetaResponses

fn register(_registry: &mut Registry)

Implementors

impl<T: Payload + IntoResponse> Response for T