Struct ApiEndpoint 

pub struct ApiEndpoint {
    pub group: String,
    pub name: String,
    pub method: String,
    pub path: String,
    pub label: String,
}

One callable endpoint a plugin advertises for service discovery. Returned from Plugin::api_endpoints and collected at App::build() into crate::migrate::registered_api_endpoints.

The shape is deliberately minimal and origin-agnostic: path is relative, so the type carries no assumption about the public host. A consumer (a REST API root, a SPA) joins its own origin to build an absolute URL. group lets a consumer bucket endpoints by source ("oauth", "tasks"); name is a stable machine key within the group ("google.login"); label is the human string a UI renders.

Fields

group: String

Grouping key, e.g. "oauth". Lets a consumer bucket endpoints by the plugin/area that contributed them.

name: String

Stable machine name within the group, e.g. "google.login".

method: String

HTTP method, uppercase: "GET", "POST", …

path: String

Relative path, e.g. "/oauth/google/login". No origin.

label: String

Human label a UI renders, e.g. "Sign in with Google".

Trait Implementations

impl Clone for ApiEndpoint

fn clone(&self) -> ApiEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.