Struct EndpointInfo 

pub struct EndpointInfo {
    pub method: String,
    pub path: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub deprecated: bool,
    pub security: Vec<String>,
    pub operation_id: Option<String>,
}

An OpenAPI endpoint for display.

Fields

method: String

HTTP method.

path: String

Path pattern.

summary: Option<String>

Operation summary.

description: Option<String>

Operation description.

tags: Vec<String>

Tags for grouping.

deprecated: bool

Whether deprecated.

security: Vec<String>

Security requirements.

operation_id: Option<String>

Operation ID.

Implementations

impl EndpointInfo

pub fn new(method: impl Into<String>, path: impl Into<String>) -> Self

Create a new endpoint info.

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

Set the summary.

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

Set the description.

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

Add a tag.

pub fn deprecated(self, deprecated: bool) -> Self

Mark as deprecated.

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

Add a security requirement.

pub fn operation_id(self, id: impl Into<String>) -> Self

Set the operation ID.

Trait Implementations

impl Clone for EndpointInfo

fn clone(&self) -> EndpointInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointInfo

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

Formats the value using the given formatter.