utoipa-config

Config for controlling utoipa's various aspects

3 releases

new 0.1.1 Oct 16, 2024
0.1.0 Oct 14, 2024
0.1.0-rc.0 Oct 2, 2024

#1228 in Web programming

Download history 107/week @ 2024-09-27 47/week @ 2024-10-04 315/week @ 2024-10-11

469 downloads per month
Used in 2 crates (via utoipa-gen)

MIT/Apache

13KB
101 lines

utoipa-config

Utoipa build crates.io docs.rs rustc

This crate provides global configuration capabilities for utoipa.

Config options

  • Define rust type aliases for utoipa with .alias_for(...) method.
  • Define schema collect mode for utoipa with .schema_collect(...) method.
    • SchemaCollect:All will collect all schemas from usages including inlined with inline(T)
    • SchemaCollect::NonInlined will only collect non inlined schemas from usages.

Install

Add dependency declaration to Cargo.toml.

[build-dependencies]
utoipa-config = "0.1"

Examples

Create build.rs file with following content, then in your code you can just use MyType as alternative for i32.

use utoipa_config::Config;

fn main() {
    Config::new()
        .alias_for("MyType", "i32")
        .write_to_file();
}

See full example for utoipa-config.

License

Licensed under either of Apache 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be dual licensed, without any additional terms or conditions.

Dependencies

~1–1.8MB
~40K SLoC