Struct seamless::api::RouteInfo [−][src]
pub struct RouteInfo {
pub name: String,
pub method: String,
pub description: String,
pub request_type: ApiBodyInfo,
pub response_type: ApiBodyInfo,
}
Expand description
Information about a single route.
Fields
name: String
The name/path that the http::Request
needs to contain
in order to match this route.
method: String
The HTTP method expected in order for a http::Request
to
match this route, as a string.
description: String
The description of the route as set by RouteBuilder::description()
request_type: ApiBodyInfo
The shape of the data expected to be provided as part of the http::Request
for this route. This doesn’t care about the wire format that the data is provided in,
though the type information is somewhat related to what the possible types that can
be sent and received via JSON.
Types can use the crate::ApiBody
macro, or implement crate::api::ApiBody
manually in order to describe the shape and documentation that they should hand back.
response_type: ApiBodyInfo
The shape of the data that is returned from this API route.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for RouteInfo
impl UnwindSafe for RouteInfo
Blanket Implementations
Mutably borrows from an owned value. Read more