Trait rocket_okapi::request::OpenApiFromRequest
source · [−]pub trait OpenApiFromRequest<'a>: FromRequest<'a> {
fn from_request_input(
gen: &mut OpenApiGenerator,
name: String,
required: bool
) -> Result<RequestHeaderInput>;
fn get_responses(_gen: &mut OpenApiGenerator) -> Result<Responses> { ... }
}Expand description
Trait that needs to be implemented for all types that implement
FromRequest.
This trait specifies what headers or other parameters are required for this
Request Guards
to be validated successfully.
If it does not quire any headers or parameters you can use the derive macro:
ⓘ
use rocket_okapi::request::OpenApiFromRequest;
#[derive(OpenApiFromRequest)]
pub struct MyStructName;Required Methods
fn from_request_input(
gen: &mut OpenApiGenerator,
name: String,
required: bool
) -> Result<RequestHeaderInput>
fn from_request_input(
gen: &mut OpenApiGenerator,
name: String,
required: bool
) -> Result<RequestHeaderInput>
Specifies what headers or other parameters are required for this Request Guards to validate successfully.
Provided Methods
fn get_responses(_gen: &mut OpenApiGenerator) -> Result<Responses>
fn get_responses(_gen: &mut OpenApiGenerator) -> Result<Responses>
Optionally add responses to the Request Guard. This can be used for when the request guard could return a “401 Unauthorized”. Or any other responses, other then one from the default response.