Struct ApiRouter 

pub struct ApiRouter { /* private fields */ }

Implementations

impl ApiRouter

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

pub fn route(self, path: &str, method_router: MethodRouter) -> Self

pub fn get<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

pub fn post<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

pub fn put<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

pub fn delete<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

pub fn patch<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T, ()>, T: 'static,

pub fn openapi_spec(&self) -> &OpenAPI

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

Set the API description

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

Set the terms of service URL

pub fn contact( self, name: Option<&str>, url: Option<&str>, email: Option<&str>, ) -> Self

Set contact information

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

Set contact email only

pub fn license(self, name: &str, url: Option<&str>) -> Self

Set license information

pub fn tag(self, name: &str, description: Option<&str>) -> Self

Add a tag definition

pub fn tag_with_docs( self, name: &str, description: Option<&str>, docs_description: Option<&str>, docs_url: &str, ) -> Self

Add a tag with external documentation

pub fn openapi_json(&mut self) -> String

pub fn get_unused_schemas(&mut self) -> Vec<String>

Get a list of unused schemas (schemas that are registered but not referenced in any endpoint)

pub fn get_unused_schemas_current(&self) -> Vec<String>

Get unused schemas without triggering OpenAPI generation (for testing)

pub fn warn_unused_schemas(&mut self)

Print warnings for unused schemas

pub fn with_openapi_routes(self) -> Self

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

pub fn into_router(self) -> Router