sova-openapi 0.1.0

OpenAPI document generation and /docs UI for Sova
Documentation 
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

use crate::doc::Doc;
use crate::validate_meta::OpenApiValidate;
use sova_core::extend::{RouteEntry, RouteTable};
use sova_core::App;

/// Routes that lack a [`Doc`] / [`OpenApiValidate`] (and are not skip / under docs).
pub fn undocumented(app: &App) -> Vec<String> {
    undocumented_with_prefix(app, "/docs")
}

pub fn undocumented_with_prefix(app: &App, docs_prefix: &str) -> Vec<String> {
    let entries = app.route_entries();
    undocumented_entries(entries.iter(), docs_prefix)
}

/// Same as [`undocumented`], using a compiled [`RouteTable`] (e.g. from `check` state).
pub fn undocumented_from_table(table: &RouteTable, docs_prefix: &str) -> Vec<String> {
    undocumented_entries(table.0.iter(), docs_prefix)
}

fn undocumented_entries<'a>(
    entries: impl IntoIterator<Item = &'a RouteEntry>,
    docs_prefix: &str,
) -> Vec<String> {
    let prefix = docs_prefix.trim_end_matches('/');
    let mut out = Vec::new();
    for entry in entries {
        let RouteEntry::Http {
            method,
            path,
            meta,
        } = entry
        else {
            continue;
        };
        if path == prefix || path.starts_with(&format!("{prefix}/")) {
            continue;
        }
        if meta.get::<OpenApiValidate>().is_some() {
            continue;
        }
        match meta.get::<Doc>() {
            Some(d) if d.is_skip() => continue,
            Some(_) => continue,
            None => out.push(format!("{method} {path}")),
        }
    }
    out.sort();
    out
}