Struct rocket_okapi_fork::gen::OpenApiGenerator

pub struct OpenApiGenerator { /* fields omitted */ }

A struct that visits all rocket::Routes, and aggregates information about them.

Implementations

impl OpenApiGenerator

pub fn new(settings: OpenApiSettings) -> Self

Create a new OpenApiGenerator from the settings provided.

pub fn add_security_scheme(&mut self, name: String, scheme: SecurityScheme)

Adds a security scheme to the generated output

pub fn add_operation(&mut self, op: OperationInfo)

Add a new HTTP Method to the collection of endpoints in the OpenApiGenerator.

pub fn json_schema<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject

Returns a JSON Schema object for the type T.

pub fn schema_generator(&self) -> &SchemaGenerator

Obtain the internal SchemaGenerator object.

pub fn json_schema_no_ref<T: ?Sized + JsonSchema>(&mut self) -> SchemaObject

Return the component definition/schema of an object without any references.

pub fn into_openapi(self) -> OpenApi

Generate an OpenApi specification for all added operations.

Trait Implementations

impl Clone for OpenApiGenerator

fn clone(&self) -> OpenApiGenerator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.