Expand description
rustlavel-openapi: API documentation, generated from the routes themselves.
The router already knows every path, method, and parameter; the route builder carries the prose. Nothing has to be repeated in a separate file, which is the reason hand-written API docs go stale.
let info = Info::from_config(&config); // openapi.title, openapi.version, openapi.prefixand in main.rs, App::new()?.routes(routes::api::routes).openapi(info).
There is no plugin here and no OpenApi type. This crate generates a
document rather than owning a piece of the application, so the meta-crate
mounts it with App::openapi and mount does the same for a bare
router. The paragraph that used to be here showed .plugin(OpenApi::new(…))
— a call to a type that has never existed — and it was an ignore block,
so nothing caught it. This one is compiled.
Modules§
- docs
- The human-readable documentation page.
Structs§
- Info
- What the generated document says about the API as a whole.