aidecomment

Crates.ioaidecomment
lib.rsaidecomment
version0.1.1
sourcesrc
created_at2024-02-15 22:37:45.278742
updated_at2024-02-16 01:39:25.391226
descriptionA Rust crate that can get the OpenAPI operation summary and description from doc comments and provide them to aide
homepage
repository
max_upload_size
id1141651
size6,075
Trevor Wilson (kmdreko)

documentation

README

Aide Comment

This crate provides a macro that can be used to extract a summary and description for an OpenAPI operation from doc comments. This crate supports axum and integrates this information with aide.

/// This is a summary
///
/// This is a longer description of the endpoint that is expected to be much
/// more detailed and may span more lines than the first paragraph summary.
#[aidecomment]
async fn my_handler() -> &'static str {
    "hello world"
}
Commit count: 0

cargo fmt