Struct AuthRoute 

pub struct AuthRoute {
    pub server_only: bool,
    pub path: String,
    pub method: HttpMethod,
    pub operation_id: String,
    pub openapi: Option<OpenApiRouteMetadata>,
    pub endpoint_key: Option<String>,
    pub allowed_media_types: Vec<String>,
    pub query_validator: Option<QueryValidator>,
    pub body_validator: Option<BodyValidator>,
    pub require_headers: bool,
}

Route definition for plugins

Fields

server_only: bool

Native-only endpoints cannot match HTTP routing.

path: String

method: HttpMethod

operation_id: String

Identifier used as the OpenAPI operationId for this route.

openapi: Option<OpenApiRouteMetadata>

Explicit OpenAPI documentation. This does not validate endpoint input.

endpoint_key: Option<String>

Upstream API key used when excluding plugin endpoints that replace core endpoints.

allowed_media_types: Vec<String>

HTTP media types accepted before endpoint middleware. Empty uses the JSON default.

query_validator: Option<QueryValidator>

Query validation runs after before hooks and before endpoint middleware.

body_validator: Option<BodyValidator>

require_headers: bool

Header presence is validated after body and query, before endpoint middleware.

Implementations

impl AuthRoute

pub fn server_only(method: HttpMethod, operation_id: impl Into<String>) -> Self

Define an endpoint that is available only through trusted native facades.

pub fn matches(&self, method: &HttpMethod, path: &str) -> bool

Match the method and slash-separated path, including named {parameter} segments.

pub fn openapi(self, metadata: OpenApiRouteMetadata) -> Self

pub fn endpoint_key(self, key: impl Into<String>) -> Self

pub fn body_validator( self, validator: impl Fn(&AuthRequest) -> AuthResult<ValidatedBody> + Send + Sync + 'static, ) -> Self

Install a body validator. Body validation precedes query validation.

pub fn body_validator_async<F, Fut>(self, validator: F) -> Self

where F: Fn(AuthRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<ValidatedBody>> + Send + 'static,

Install an asynchronous body validator at the same phase as synchronous validation.

pub fn query_validator(self, validator: QueryValidator) -> Self

Install a query validator for the endpoint handler and its middleware.

pub fn require_headers(self, required: bool) -> Self

pub fn allowed_media_types(self, types: &[&str]) -> Self

pub fn new( method: HttpMethod, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

pub fn get(path: impl Into<String>, operation_id: impl Into<String>) -> Self

pub fn post(path: impl Into<String>, operation_id: impl Into<String>) -> Self

pub fn put(path: impl Into<String>, operation_id: impl Into<String>) -> Self

pub fn delete(path: impl Into<String>, operation_id: impl Into<String>) -> Self

Trait Implementations

impl Clone for AuthRoute

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRoute

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

Formats the value using the given formatter.