Struct Document 

pub struct Document { /* private fields */ }

Available on crate feature openapi only.

An OpenAPI document that describes the documented routes of a router.

Create it with OpenApi::generate. Return it from a route to serve it as JSON, or write it to a file with to_json_pretty. It also implements Serialize for other formats.

Implementations

impl Document

pub fn to_json(&self) -> String

Returns the document as compact JSON.

Panics

Panics if a schema in the document cannot be written as JSON.

pub fn to_json_pretty(&self) -> String

Returns the document as indented JSON, which suits a file kept in version control.

Panics

Panics if a schema in the document cannot be written as JSON.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl IntoResponse for &Document

Sends the document as JSON.

fn into_response(self, cx: &Cx) -> Result<Response<Body>, Error>

Converts self into an HTTP Response, using the request Cx for any request-scoped data.

impl IntoResponse for Document

Sends the document as JSON.

fn into_response(self, cx: &Cx) -> Result<Response<Body>, Error>

Converts self into an HTTP Response, using the request Cx for any request-scoped data.

impl Serialize for Document

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.