Struct ApiDocBuilder

pub struct ApiDocBuilder { /* private fields */ }

API documentation builder

Implementations

impl ApiDocBuilder

pub fn new(title: &str, version: &str) -> Self

pub fn description(self, description: &str) -> Self

pub fn base_url(self, base_url: &str) -> Self

pub fn add_version(self, version: ApiVersion) -> Self

pub fn add_endpoint(self, endpoint: EndpointDoc) -> Self

pub fn generate_openapi(&self) -> Value

Generate OpenAPI 3.0 specification

pub fn generate_html_docs(&self) -> String

Generate simple HTML documentation

Trait Implementations

impl Clone for ApiDocBuilder

fn clone(&self) -> ApiDocBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.