Struct RouteMetadata 

pub struct RouteMetadata {
    pub path: String,
    pub method: String,
    pub protocol: String,
    pub description: Option<String>,
    pub request_schema: Option<Value>,
    pub response_schema: Option<Value>,
}

Metadata about a registered route

Contains all information needed to generate documentation for a route across different protocols (REST, GraphQL, gRPC).

Fields

path: String

The route path (e.g., “/users”, “/users/{id}”)

method: String

HTTP method for REST routes (e.g., “GET”, “POST”) Empty for non-REST protocols

protocol: String

Protocol this route belongs to (e.g., “rest”, “graphql”, “grpc”)

description: Option<String>

Optional description from doc comments

request_schema: Option<Value>

Request schema as JSON Schema (if available)

response_schema: Option<Value>

Response schema as JSON Schema (if available)

Implementations

impl RouteMetadata

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

Create a new RouteMetadata

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

Set the description

pub fn with_request_schema(self, schema: Value) -> RouteMetadata

Set the request schema

pub fn with_response_schema(self, schema: Value) -> RouteMetadata

Set the response schema

Trait Implementations

impl Clone for RouteMetadata

fn clone(&self) -> RouteMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RouteMetadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<RouteMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RouteMetadata

fn eq(&self, other: &RouteMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RouteMetadata

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.

impl StructuralPartialEq for RouteMetadata