vimanam 0.2.2

OpenAPI/Swagger to Markdown documentation generator with grouping, filtering, and detail levels for docs and LLM context
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

mod config;
mod markdown;
mod models;
mod parser;
mod utils;

use std::fs::File;
use std::io::{stdout, BufWriter};
use std::process;

use anyhow::{Context, Result};
use clap::Parser;
use log::{error, info};

use crate::config::{build_config, Cli};
use crate::markdown::generate_markdown;
use crate::parser::parse_openapi;

/// Parses CLI arguments, parses the spec, and writes markdown to the
/// requested output (file or stdout).
fn run() -> Result<()> {
    // Initialize logger
    env_logger::init();

    // Parse command-line arguments
    let cli = Cli::parse();

    // Build configuration
    let config = build_config(&cli);

    // Parse OpenAPI spec
    let api_doc = parse_openapi(&cli.input)
        .with_context(|| format!("Failed to parse OpenAPI file: {:?}", cli.input))?;

    // Generate markdown
    if let Some(output_path) = &cli.output {
        // Write to file
        let file = File::create(output_path)
            .with_context(|| format!("Failed to create output file: {:?}", output_path))?;
        let mut writer = BufWriter::new(file);

        generate_markdown(&mut writer, &api_doc, &config)
            .with_context(|| "Failed to generate markdown")?;

        info!("Documentation written to: {:?}", output_path);
    } else {
        // Write to stdout
        let mut writer = stdout();

        generate_markdown(&mut writer, &api_doc, &config)
            .with_context(|| "Failed to generate markdown")?;
    }

    Ok(())
}

fn main() {
    if let Err(err) = run() {
        error!("Error: {:#}", err);
        process::exit(1);
    }
}