Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

OpenAPI document builder.

Implementations

impl OpenApiBuilder

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

Create a new builder.

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

Add a description.

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

Add a server.

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

Add a tag.

pub fn schema(self, name: impl Into<String>, schema: Schema) -> Self

Add a schema component.

pub fn registry(&mut self) -> SchemaRegistryMut<'_>

Access the component schema registry for in-place registration.

pub fn add_route(&mut self, route: &Route)

Add a metadata-rich route (from fastapi-router) as an OpenAPI operation.

This is a convenience bridge used by integration tests and by higher-level crates.

pub fn add_routes<'a, I>(&mut self, routes: I)

where I: IntoIterator<Item = &'a Route>,

Add multiple routes.

pub fn operation( self, method: &str, path: impl Into<String>, operation: Operation, ) -> Self

Add a path operation (GET, POST, etc.).

This is the primary method for registering routes with OpenAPI.

Example

let builder = OpenApiBuilder::new("My API", "1.0.0")
    .operation("GET", "/users", Operation {
        operation_id: Some("get_users".to_string()),
        summary: Some("List all users".to_string()),
        responses: HashMap::from([
            ("200".to_string(), Response {
                description: "Success".to_string(),
                content: HashMap::new(),
            })
        ]),
        ..Default::default()
    });

pub fn get( self, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

Add a simple GET endpoint with default 200 response.

pub fn post( self, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

Add a simple POST endpoint with default 200 response.

pub fn put( self, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

Add a simple PUT endpoint with default 200 response.

pub fn delete( self, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

Add a simple DELETE endpoint with default 200 response.

pub fn patch( self, path: impl Into<String>, operation_id: impl Into<String>, ) -> Self

Add a simple PATCH endpoint with default 200 response.

pub fn build(self) -> OpenApi

Build the OpenAPI document.