Struct rocket_okapi::gen::OpenApiGenerator
source · [−]pub struct OpenApiGenerator { /* private fields */ }
Expand description
A struct that visits all rocket::Route
s, and aggregates information about them.
Implementations
sourceimpl OpenApiGenerator
impl OpenApiGenerator
sourcepub fn new(settings: &OpenApiSettings) -> Self
pub fn new(settings: &OpenApiSettings) -> Self
Create a new OpenApiGenerator
from the settings provided.
sourcepub fn add_security_scheme(&mut self, name: String, scheme: SecurityScheme)
pub fn add_security_scheme(&mut self, name: String, scheme: SecurityScheme)
Adds/Replace a security scheme to the generated output
sourcepub fn add_operation(&mut self, op: OperationInfo)
pub fn add_operation(&mut self, op: OperationInfo)
Add a new HTTP Method
to the collection of endpoints in the OpenApiGenerator
.
sourcepub fn json_schema<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject
pub fn json_schema<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject
Returns a JSON Schema object for the type T
.
sourcepub fn schema_generator(&self) -> &SchemaGenerator
pub fn schema_generator(&self) -> &SchemaGenerator
Obtain the internal SchemaGenerator
object.
sourcepub fn json_schema_no_ref<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject
pub fn json_schema_no_ref<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject
Return the component definition/schema of an object without any references.
sourcepub fn into_openapi(self) -> OpenApi
pub fn into_openapi(self) -> OpenApi
Generate an OpenApi
specification for all added operations.
Trait Implementations
sourceimpl Clone for OpenApiGenerator
impl Clone for OpenApiGenerator
sourcefn clone(&self) -> OpenApiGenerator
fn clone(&self) -> OpenApiGenerator
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for OpenApiGenerator
impl !Send for OpenApiGenerator
impl !Sync for OpenApiGenerator
impl Unpin for OpenApiGenerator
impl !UnwindSafe for OpenApiGenerator
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
Converts self
into a collection.
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more