Struct OpenApi3Generator 

pub struct OpenApi3Generator;

Renders the registry contents as an OpenAPI 3.1 JSON document.

Only routes with a non-empty group are emitted, and routes owned by the documentation controller itself are skipped. The result is built fresh on every call; the documentation controller caches the rendered string.

Implementations

impl OpenApi3Generator

pub fn generate(registrant: &DocumentationRegistrant) -> Value

Generates an OpenAPI 3.1 document from the registrant.

Uses the application environment for the info.title and info.version when available, falling back to "API Documentation" / "1.0.0".

let spec = crate::doc::OpenApi3Generator::generate(&registrant);
assert_eq!(spec["openapi"], "3.1.0");

pub fn generate_with_title( registrant: &DocumentationRegistrant, title: &str, version: &str, ) -> Value

Generates an OpenAPI 3.1 document with an explicit title and version.

Behaves as generate but overrides the info.title and info.version taken from the environment.