Trait rocket_okapi::response::OpenApiResponder

pub trait OpenApiResponder<'r>: Responder<'r> {
    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.

Loading content...

Implementations on Foreign Types

impl<T: JsonSchema + Serialize, '_> OpenApiResponder<'_> for Json<T>

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

impl<'_> OpenApiResponder<'_> for JsonValue

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

impl<'_> OpenApiResponder<'_> for String

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

impl<'r> OpenApiResponder<'r> for &'r str

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

impl<'_> OpenApiResponder<'_> for Vec<u8>

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

impl<'r> OpenApiResponder<'r> for Response<'r>

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

impl<'r> OpenApiResponder<'r> for &'r [u8]

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

impl<'_> OpenApiResponder<'_> for ()

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Option<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Accepted<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Created<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for BadRequest<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Unauthorized<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Forbidden<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for NotFound<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Conflict<T>

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

impl<'_> OpenApiResponder<'_> for NoContent

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Css<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Html<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for JavaScript<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Json<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for MsgPack<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Plain<T>

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

impl<'r, T: OpenApiResponder<'r>> OpenApiResponder<'r> for Xml<T>

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

impl<'r, T: OpenApiResponder<'r>, E: Debug> OpenApiResponder<'r> for StdResult<T, E>

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

impl<'r, T: OpenApiResponder<'r>, E: Responder<'r> + Debug> OpenApiResponder<'r> for StdResult<T, E>

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

impl<'r, T: OpenApiResponder<'r>, E: OpenApiResponder<'r> + Debug> OpenApiResponder<'r> for StdResult<T, E>

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

Loading content...

Implementors

Loading content...