Struct aide::transform::TransformOpenApi

pub struct TransformOpenApi<'t> { /* private fields */ }

A transform helper that wraps OpenApi.

Implementations

impl<'t> TransformOpenApi<'t>

pub fn new(api: &'t mut OpenApi) -> Self

Create a new transform helper.

pub fn title(self, title: &str) -> Self

Set the title.

pub fn summary(self, summary: &str) -> Self

Set the summary.

pub fn tos(self, tos: &str) -> Self

Set the terms of service.

pub fn description(self, description: &str) -> Self

Set the description.

pub fn version(self, version: &str) -> Self

Set the version.

pub fn contact(self, contact: Contact) -> Self

Set API contact information.

pub fn license(self, license: License) -> Self

Set API license information.

pub fn info(self, info: Info) -> Self

Override all API information.

pub fn tag(self, tag: Tag) -> Self

Add a tag to the documentation.

pub fn server(self, server: Server) -> Self

Add a server to the documentation.

pub fn default_response<R>(self) -> Selfwhere R: OperationOutput,

Set a default response for all operations that do not already have one.

pub fn default_response_with<R, F>(self, transform: F) -> Selfwhere R: OperationOutput, F: Fn(TransformResponse<'_, R::Inner>) -> TransformResponse<'_, R::Inner> + Clone,

Set a default response for all operations that do not already have one.

This method additionally accepts a transform function to modify the generated documentation.

pub fn security_scheme(self, name: &str, scheme: SecurityScheme) -> Self

Add a security scheme.

pub fn security_requirement(self, security_scheme: &str) -> Self

Add a global security requirement.

pub fn security_requirement_multi<'a, I>(self, security_schemes: I) -> Selfwhere I: IntoIterator<Item = &'a str> + Clone,

Add multiple global security requirement.

pub fn security_requirement_scopes<I, S>( self, security_scheme: &str, scopes: I ) -> Selfwhere I: IntoIterator<Item = S>, S: Into<String>,

Add required scopes to a global security requirement.

If the scheme requirement does not exist, it will be added.

pub fn security_requirement_multi_scopes<'a, I, IS, S>( self, security_schemes: I, scopes: IS ) -> Selfwhere I: IntoIterator<Item = &'a str> + Clone, IS: IntoIterator<Item = S>, S: Into<String>,

Add required scopes to multi global security requirement.

If the scheme requirement does not exist, it will be added.

pub fn with(self, transform: impl FnOnce(Self) -> Self) -> Self

Apply an another transform function.

pub fn inner_mut(&mut self) -> &mut OpenApi

Access the inner OpenApi.