Trait salvo::prelude::ToResponses

source ·

pub trait ToResponses {
    // Required method
    fn to_responses(components: &mut Components) -> Responses;
}

Available on crate feature oapi only.

Expand description

This trait is implemented to document a type (like an enum) which can represent multiple responses, to be used in operation.

§Examples

use std::collections::BTreeMap;
use salvo_oapi::{Components, Response, Responses, RefOr, ToResponses };

enum MyResponse {
    Ok,
    NotFound,
}

impl ToResponses for MyResponse {
    fn to_responses(_components: &mut Components) -> Responses {
        Responses::new()
            .response("200", Response::new("Ok"))
            .response("404", Response::new("Not Found"))
    }
}