rocket_okapi 0.3.6

OpenAPI (AKA Swagger) document generation for Rocket applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13

mod responder_impls;

use super::gen::OpenApiGenerator;
use super::Result;
use okapi::openapi3::Responses;

/// Implementing this trait means that any route returning the implementer can be marked with
/// `#[openapi]`, and that the route can be documented.
pub trait OpenApiResponder<'r>: rocket::response::Responder<'r> {
    /// Create the responses type, which is a list of responses that can be rendered in
    /// `openapi.json` format.
    fn responses(gen: &mut OpenApiGenerator) -> Result<Responses>;
}