Struct OpenApiSummary 

pub struct OpenApiSummary {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub servers: Vec<String>,
    pub endpoints: Vec<EndpointInfo>,
    pub endpoint_count: usize,
}

OpenAPI spec summary for display.

Fields

title: String

API title.

version: String

API version.

description: Option<String>

API description.

servers: Vec<String>

Server URLs.

endpoints: Vec<EndpointInfo>

Endpoints.

endpoint_count: usize

Total endpoint count.

Implementations

impl OpenApiSummary

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

Create a new OpenAPI summary.

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

Set the description.

pub fn server(self, url: impl Into<String>) -> Self

Add a server URL.

pub fn endpoint(self, endpoint: EndpointInfo) -> Self

Add an endpoint.

Trait Implementations

impl Clone for OpenApiSummary

fn clone(&self) -> OpenApiSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSummary

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

Formats the value using the given formatter.