Struct OpenApiRoute 

pub struct OpenApiRoute { /* private fields */ }

OpenAPI route metadata.

Implementations

impl OpenApiRoute

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

Creates GET route metadata.

pub fn try_get(path: impl Into<String>) -> Result<Self, RoutePathError>

Tries to create GET route metadata.

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

Creates POST route metadata.

pub fn try_post(path: impl Into<String>) -> Result<Self, RoutePathError>

Tries to create POST route metadata.

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

Creates PUT route metadata.

pub fn try_put(path: impl Into<String>) -> Result<Self, RoutePathError>

Tries to create PUT route metadata.

pub fn patch(path: impl Into<String>) -> Self

Creates PATCH route metadata.

pub fn try_patch(path: impl Into<String>) -> Result<Self, RoutePathError>

Tries to create PATCH route metadata.

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

Creates DELETE route metadata.

pub fn try_delete(path: impl Into<String>) -> Result<Self, RoutePathError>

Tries to create DELETE route metadata.

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

Sets the route summary.

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

Adds an OpenAPI tag to this operation.

pub fn response_status(self, status: StatusCode) -> Self

Sets the successful response status for this operation.

pub fn request_schema<T>(self) -> Self

where T: ToSchema,

Sets the JSON request body schema reference.

pub fn response_schema<T>(self) -> Self

where T: ToSchema,

Sets the successful JSON response schema reference.

Trait Implementations

impl Clone for OpenApiRoute

fn clone(&self) -> OpenApiRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiRoute

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

Formats the value using the given formatter.