Struct OpenApiRouteConfig 

pub struct OpenApiRouteConfig { /* private fields */ }

Per-route OpenAPI metadata.

Implementations

impl OpenApiRouteConfig

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

Adds a tag to the operation.

pub fn with_tags<I, T>(self, tags: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Adds multiple tags to the operation.

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

Binds the operation with a document

pub fn with_docs<I, S>(self, docs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Binds the operation with documents

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

Sets the operation summary.

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

Sets the operation description.

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

Sets the operation id.

pub fn with_request_schema(self, schema: OpenApiSchema) -> Self

Sets the request body schema for this operation.

pub fn with_response_schema( self, status: impl IntoStatusCode, schema: OpenApiSchema, ) -> Self

Sets the response schema for this operation.

pub fn consumes_named_path<T: DeserializeOwned>(self) -> Self

Generates path parameters schema.

pub fn consumes_query<T: DeserializeOwned>(self) -> Self

Generates query parameters schema.

pub fn consumes_json<T: DeserializeOwned>(self) -> Self

Generates JSON request schema and example.

pub fn consumes_form<T: DeserializeOwned>(self) -> Self

Generates form request schema and example.

pub fn consumes_multipart(self) -> Self

Generates multipart request schema.

pub fn consumes_stream(self) -> Self

Generates stream request schema.

pub fn produces_text(self, status: impl IntoStatusCode) -> Self

Generates text/plain response schema.

pub fn produces_no_schema(self, status: impl IntoStatusCode) -> Self

Generates a response without a schema.

pub fn produces_json<T: Serialize + Default>( self, status: impl IntoStatusCode, ) -> Self

Generates JSON response schema and example from T::default().

pub fn produces_empty_json(self, status: impl IntoStatusCode) -> Self

Generates empty JSON response schema.

pub fn produces_form<T: Serialize + Default>( self, status: impl IntoStatusCode, ) -> Self

Generates form response schema and example from T::default().

pub fn produces_empty_form(self, status: impl IntoStatusCode) -> Self

Generates empty form response schema.

pub fn produces_stream(self, status: impl IntoStatusCode) -> Self

Generates stream response schema.

pub fn produces_sse(self, status: impl IntoStatusCode) -> Self

Generates SSE stream response schema.

pub fn produces_json_example<T: Serialize>( self, status: impl IntoStatusCode, example: T, ) -> Self

Generates JSON response schema and example.

pub fn produces_form_example<T: Serialize>( self, status: impl IntoStatusCode, example: T, ) -> Self

Generates form response schema and example.

pub fn merge(self, other: &Self) -> Self

Merges configurations.

Trait Implementations

impl Clone for OpenApiRouteConfig

fn clone(&self) -> OpenApiRouteConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiRouteConfig

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

Formats the value using the given formatter.

impl Default for OpenApiRouteConfig

fn default() -> OpenApiRouteConfig

Returns the “default value” for a type.