Crate reinhardt_openapi 

Reinhardt OpenAPI Router

OpenAPI router wrapper that automatically adds documentation endpoints.

Overview

This crate provides a router wrapper that intercepts requests to OpenAPI documentation paths and serves them from memory, delegating all other requests to the wrapped handler.

Example

Apply OpenApiRouter::wrap inside the #[routes] function to expose OpenAPI documentation alongside your application routes:

use reinhardt::routes;
use reinhardt_openapi::OpenApiRouter;
use reinhardt_urls::routers::UnifiedRouter;

#[routes]
pub fn routes() -> OpenApiRouter<UnifiedRouter> {
    let router = UnifiedRouter::new()
        // Mount your application routes here
        .mount("/", some_app::urls::routes());

    // Wrap with OpenAPI endpoints — served at:
    // - /api/openapi.json (OpenAPI spec)
    // - /api/docs (Swagger UI)
    // - /api/redoc (Redoc UI)
    OpenApiRouter::wrap(router).expect("Failed to wrap router with OpenAPI")
}

Separation Rationale

This crate exists separately from reinhardt-rest to break a circular dependency chain:

reinhardt-urls → reinhardt-views → reinhardt-rest → reinhardt-urls (cycle!)

By placing OpenApiRouter in its own crate that depends on both reinhardt-urls and reinhardt-rest, we avoid this cycle:

reinhardt-openapi
    ├── reinhardt-urls (Route, Router trait)
    └── reinhardt-rest (generate_openapi_schema, SwaggerUI, RedocUI)

Structs

OpenApiRouter

Router wrapper that adds OpenAPI documentation endpoints

Enums

SchemaError

Errors that can occur during OpenAPI schema operations.

Type Aliases

AuthGuard

Type alias for the authentication guard callback.