Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub operations: Vec<(String, String, Operation)>,
}

Available on crate feature openapi only.

Metadata for the generated OpenAPI document, and the described operations.

Fields

title: String

version: String

description: Option<String>

operations: Vec<(String, String, Operation)>

(method, route pattern, operation), as given to OpenApiConfig::operation.

Implementations

impl OpenApiConfig

pub fn new( title: impl Into<String>, version: impl Into<String>, ) -> OpenApiConfig

Create a config with the required title and version fields.

pub fn description(self, description: impl Into<String>) -> OpenApiConfig

Set the OpenAPI document’s info.description.

pub fn operation( self, method: &str, pattern: &str, operation: Operation, ) -> OpenApiConfig

Describe the operation for method and route pattern (as registered: /users/:id). An operation for a pattern no route has is still documented — for routes served outside the router.

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiConfig

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

Formats the value using the given formatter.