Struct RouterAndDocs 

pub struct RouterAndDocs {
    pub router: Router<AppState>,
    pub docs: OpenApi,
}

Encapsulates both an axum router and a set of OpenApi docs. Use the router_with_docs! macro to create one of these.

Fields

router: Router<AppState>

docs: OpenApi

Implementations

impl RouterAndDocs

pub fn register<T, H>(&mut self, api: OpenApi, handler: H)

where T: 'static, H: 'static + Handler<T, AppState>,

Register a route based on the definition contained in the provided OpenApi docs. This will extract the path and correct operation type from the openapi docs and use that to register the handler, allowing the path and operation for the handler to be centrally defined in the utoipa::path macro annotation on the handler itself.

You will not call this directly: it will be called via the router_with_docs! macro invocation.

The OpenApi instance MUST have only a single path with a single operation defined within it. This is upheld in the macro implementation.

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

Create a new RouterAndDocs instance. You should trigger this via the router_with_docs! macro rather than using it directly.