Struct dropshot::ApiEndpoint

pub struct ApiEndpoint {
    pub operation_id: String,
    pub handler: Box<dyn RouteHandler>,
    pub method: Method,
    pub path: String,
    pub parameters: Vec<ApiEndpointParameter>,
    pub response: ApiEndpointResponse,
    pub description: Option<String>,
    pub tags: Vec<String>,
}

ApiEndpoint represents a single API endpoint associated with an ApiDescription. It has a handler, HTTP method (e.g. GET, POST), and a path-- provided explicitly--as well as parameters and a description which can be inferred from function parameter types and doc comments (respectively).

Fields

operation_id: String

handler: Box<dyn RouteHandler>

method: Method

path: String

parameters: Vec<ApiEndpointParameter>

response: ApiEndpointResponse

description: Option<String>

tags: Vec<String>

Implementations

impl<'a> ApiEndpoint

pub fn new<HandlerType, FuncParams, ResponseType>(
    operation_id: String,
    handler: HandlerType,
    method: Method,
    path: &'a str
) -> Self where
    HandlerType: HttpHandlerFunc<FuncParams, ResponseType>,
    FuncParams: Extractor + 'static,
    ResponseType: HttpResponse + Send + Sync + 'static, 

pub fn description<T: ToString>(self, description: T) -> Self

pub fn tag<T: ToString>(self, tag: T) -> Self

Trait Implementations

impl Debug for ApiEndpoint

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

Formats the value using the given formatter.