Struct OpenApiDocument 

pub struct OpenApiDocument { /* private fields */ }

A generated, serializable OpenAPI document.

Implementations

impl OpenApiDocument

pub fn from_application( application: &CompiledHttpApplication, config: &OpenApiConfig, ) -> Result<Self, OpenApiError>

Discovers compiled framework routes and generates an OpenAPI 3.1 document.

Errors

Returns OpenApiError for invalid endpoints or duplicate explicit operation IDs.

pub const fn as_value(&self) -> &Value

Returns the generated JSON value.

pub fn into_value(self) -> Value

Consumes the document and returns its JSON value.

pub fn to_json_pretty(&self) -> Result<String, Error>

Serializes the document as pretty-printed JSON.

Errors

Returns a serialization error if the JSON serializer cannot encode the document.

Trait Implementations

impl Clone for OpenApiDocument

fn clone(&self) -> OpenApiDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiDocument

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

Formats the value using the given formatter.