Struct OpenApiGenerator 

pub struct OpenApiGenerator { /* private fields */ }

OpenAPI specification generator

Generates OpenAPI 3.1 compliant specifications from router metadata.

Implementations

impl OpenApiGenerator

pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self

Create a new OpenAPI generator

pub fn with_description(self, description: impl Into<String>) -> Self

Set the API description

pub fn with_server( self, url: impl Into<String>, description: Option<impl Into<String>>, ) -> Self

Add a server URL

Servers are used by the “Try It” functionality to make actual API calls.

Example

use allframe_core::router::openapi::OpenApiGenerator;

let generator = OpenApiGenerator::new("API", "1.0.0")
    .with_server("http://localhost:3000", Some("Local development"));

pub fn with_servers(self, servers: Vec<OpenApiServer>) -> Self

Add multiple servers

pub fn generate(&self, router: &Router) -> Value

Generate OpenAPI specification from router