Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

Builder for constructing an OpenAPI spec from plugins and core routes.

Implementations

impl OpenApiBuilder

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

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

pub fn route( self, method: &HttpMethod, path: &str, operation_id: &str, tag: &str, ) -> OpenApiBuilder

Add a single route entry.

pub fn plugin<DB>(self, plugin: &dyn AuthPlugin<DB>) -> OpenApiBuilder

where DB: DatabaseAdapter,

Register all routes from a plugin.

pub fn core_routes(self) -> OpenApiBuilder

Register core routes that are not part of any plugin.

pub fn build(self) -> OpenApiSpec

Build the final OpenAPI spec.