Trait rocket_okapi_fork::response::OpenApiResponderInner

pub trait OpenApiResponderInner {
    fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>;
}

Implementing this trait means that any route returning the implementer can be marked with #[openapi], and that the route can be documented.

Required methods

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

Create the responses type, which is a list of responses that can be rendered in openapi.json format.

Implementations on Foreign Types

impl<T: Serialize + JsonSchema + Send> OpenApiResponderInner for Json<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Value

fn responses(_gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for String

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for &str

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for Vec<u8>

fn responses(_: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for &[u8]

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for ()

fn responses(_: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Option<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl OpenApiResponderInner for NamedFile

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Accepted<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Created<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for BadRequest<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Unauthorized<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for Forbidden<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T> OpenApiResponderInner for NotFound<T> where
    T: OpenApiResponderInner + Send, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Css<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Html<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for JavaScript<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Json<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for MsgPack<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Plain<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<T: OpenApiResponderInner> OpenApiResponderInner for Xml<T>

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

impl<'r, 'o, T, E> OpenApiResponderInner for Result<T, E> where
    T: OpenApiResponderInner,
    E: OpenApiResponderInner, 

fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>

Implementors