Struct Bytedocs 

pub struct Bytedocs { /* private fields */ }

Main entry point for Bytedocs API documentation generation.

Bytedocs is the primary struct for creating and managing API documentation. It wraps the internal APIDocs implementation and provides a user-friendly API.

Implementations

impl Bytedocs

pub fn new(config: Option<Config>) -> Self

Creates a new Bytedocs instance with the specified configuration.

Arguments

• config - Optional configuration. If None, uses default configuration.

Example

use bytedocs_rs::Bytedocs;

let docs = Bytedocs::new(None);

pub fn from_env() -> Result<Self>

Creates a Bytedocs instance from environment variables.

Reads configuration from environment variables and validates it.

Errors

Returns an error if environment variables are invalid or configuration validation fails.

pub fn from_env_file(env_file: &str) -> Result<Self>

Creates a Bytedocs instance from a .env file.

Arguments

• env_file - Path to the environment file to load

Errors

Returns an error if the file path is empty, file cannot be read, or configuration validation fails.

pub fn add_route( &mut self, method: &str, path: &str, handler: Option<Box<dyn Any + Send + Sync>>, summary: Option<&str>, description: Option<&str>, parameters: Option<Vec<Parameter>>, request_body: Option<RequestBody>, responses: Option<HashMap<String, Response>>, ) -> Result<()>

Adds a new API route to the documentation.

Arguments

• method - HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
• path - API endpoint path (must start with ‘/’)
• handler - Optional handler function (for framework integration)
• summary - Optional short description of the endpoint
• description - Optional detailed description
• parameters - Optional list of parameters
• request_body - Optional request body specification
• responses - Optional response specifications

Errors

Returns an error if:

• Method is empty or invalid
• Path is empty or doesn’t start with ‘/’
• Path format is invalid

pub fn add_routes(&mut self, routes: Vec<RouteInfo>)

Adds multiple routes at once.

Arguments

• routes - Vector of RouteInfo structs to add

pub fn auto_detect_axum_routes(&mut self, source_paths: &[&str]) -> Result<()>

Automatically detects and extracts Axum routes from source files.

Arguments

• source_paths - Array of source file paths to scan

Errors

Returns an error if source paths are empty or route detection fails.

pub fn auto_detect_from_main(&mut self) -> Result<()>

Convenience method to auto-detect routes from src/main.rs.

Errors

Returns an error if route detection fails.

pub fn generate(&mut self) -> Result<()>

Generates the API documentation.

This must be called after adding all routes and before serving the documentation.

Errors

Returns an error if documentation generation fails.

pub fn documentation(&self) -> &Documentation

Returns a reference to the generated documentation.

pub fn config(&self) -> &Config

Returns a reference to the configuration.

pub async fn openapi_json(&mut self) -> Result<Value>

Returns the OpenAPI specification as JSON.

Errors

Returns an error if JSON generation fails.

pub async fn openapi_yaml(&mut self) -> Result<String>

Returns the OpenAPI specification as YAML.

Errors

Returns an error if YAML generation fails.

pub fn router(&self) -> Router

Returns an Axum router with all documentation routes configured.

This can be merged with your application’s existing router.

pub async fn serve(&self, addr: &str) -> Result<()>

Starts the documentation server on the specified address.

Arguments

• addr - The address to bind to (e.g., “0.0.0.0:8813”)

Errors

Returns an error if the address is empty or the server fails to start.