Skip to main content

Module openapi

Module openapi 

Source
Expand description

ApiDoc: the single [utoipa::OpenApi] aggregator listing every route and schema this crate serves. Kept as its own module (rather than folded into lib.rs) because this list is the one place that must be updated whenever a route or DTO is added – a dedicated file makes that omission easy to spot in a diff.

There is deliberately no macro or build script scanning routes/** for #[utoipa::path] annotations automatically: utoipa’s own design is to declare the aggregate explicitly, and a missing entry here fails loudly (the route exists and works, but is simply absent from /api/openapi.json and the Scalar docs at /api/docs) rather than silently – easy to catch by comparing routes::*::router() against this list in review.

Structs§

ApiDoc