Struct ApiEndpoint

pub struct ApiEndpoint<M> {
    pub path: &'static str,
    pub handler: Box<dyn for<'a> Fn(&'a M, ApiEndpointContext<'a>, ApiRequestErased) -> Pin<Box<dyn Future<Output = Result<Value, ApiError>> + Send + 'a>> + Send + Sync>,
}

Definition of an API endpoint defined by a module M.

Fields

path: &'static str

Path under which the API endpoint can be reached. It should start with a / e.g. /transaction. E.g. this API endpoint would be reachable under module_module_instance_id_transaction depending on the module name returned by [FedertionModule::api_base_name].

handler: Box<dyn for<'a> Fn(&'a M, ApiEndpointContext<'a>, ApiRequestErased) -> Pin<Box<dyn Future<Output = Result<Value, ApiError>> + Send + 'a>> + Send + Sync>

Handler for the API call that takes the following arguments:

• Reference to the module which defined it
• Request parameters parsed into JSON [Value](serde_json::Value)

Implementations

impl ApiEndpoint<()>

pub fn from_typed<E: TypedApiEndpoint>() -> ApiEndpoint<E::State>

where <E as TypedApiEndpoint>::Response: MaybeSend, E::Param: Debug, E::Response: Debug,