doku 0.21.1

A framework for documenting Rust data structures
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

use doku::Document;
use serde::Serialize;

#[derive(Serialize, Document)]
struct Response {
    #[serde(flatten)]
    pagination: PaginationWrapper,

    #[serde(rename = "items")]
    users: Vec<User>,
}

#[derive(Serialize, Document)]
#[serde(transparent)]
struct PaginationWrapper(Pagination);

#[derive(Serialize, Document)]
struct Pagination {
    current_page: usize,
    last_page: usize,
}

#[derive(Serialize, Document)]
struct User {
    #[doku(example = "alan.turing")]
    login: String,

    #[doku(example = "lofi hip hop radio")]
    favorite_radio: String,
}

fn main() {
    println!("```json");
    println!("{}", doku::to_json::<Response>());
    println!("```");
    println!();
    println!("```toml");
    println!("{}", doku::to_toml::<Response>());
    println!("```");
}