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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
#![cfg_attr(doc_cfg, feature(doc_cfg))]
//! Want to have your API documented with OpenAPI? But you don't want to see the
//! trouble with manual yaml or json tweaking? Would like it to be so easy that it would almost
//! be like utopic? Don't worry utoipa is just there to fill this gap. It aims to do if not all then
//! the most of heavy lifting for you enabling you to focus writing the actual API logic instead of
//! documentation. It aims to be *minimal*, *simple* and *fast*. It uses simple proc macros which
//! you can use to annotate your code to have items documented.
//!
//! Utoipa crate provides autogenerated OpenAPI documentation for Rust REST APIs. It treats
//! code first approach as a first class citizen and simplifies API documentation by providing
//! simple macros for generating the documentation from your code.
//!
//! It also contains Rust types of OpenAPI spec allowing you to write the OpenAPI spec only using
//! Rust if auto-generation is not your flavor or does not fit your purpose.
//!
//! Long term goal of the library is to be the place to go when OpenAPI documentation is needed in Rust
//! codebase.
//!
//! Utoipa is framework agnostic and could be used together with any web framework or even without one. While
//! being portable and standalone one of it's key aspects is simple integration with web frameworks.
//!
//! Currently utoipa provides simple integration with actix-web framework but is not limited to the actix-web
//! framework. All functionalities are not restricted to any specific framework.
//!
//! # Choose your flavor and document your API with ice cold IPA
//!
//! Existing [examples](https://github.com/juhaku/utoipa/tree/master/examples) for following frameworks:
//!
//! * **actix-web**
//! * **axum**
//! * **warp**
//! * **tide**
//! * **rocket**
//!
//! Even if there is no example for your favorite framework `utoipa` can be used with any
//! web framework which supports decorating functions with macros similarly to **warp** and **tide** examples.
//!
//! # What's up with the word play?
//!
//! The name comes from words `utopic` and `api` where `uto` is the first three letters of _utopic_
//! and the `ipa` is _api_ reversed. Aaand... `ipa` is also awesome type of beer.
//!
//! # Crate Features
//!
//! * **yaml** Enables **serde_yaml** serialization of OpenAPI objects.
//! * **actix_extras** Enhances [actix-web](https://github.com/actix/actix-web/) integration with being able to
//! parse `path`, `path` and `query` parameters from actix web path attribute macros. See [actix extras support][actix_path] or
//! [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more details.
//! * **rocket_extras** Enhances [rocket](https://github.com/SergioBenitez/Rocket) framework integration with being
//! able to parse `path`, `path` and `query` parameters from rocket path attribute macros. See [rocket extras support][rocket_path]
//! or [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more details
//! * **axum_extras** Enhances [axum](https://github.com/tokio-rs/axum) framework integration allowing users to use `IntoParams`
//! without defining the `parameter_in` attribute. See [axum extras support][axum_path]
//! or [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more details.
//! * **debug** Add extra traits such as debug traits to openapi definitions and elsewhere.
//! * **chrono** Add support for [chrono](https://crates.io/crates/chrono) `DateTime`, `Date`, `NaiveDate`, `NaiveTime` and `Duration`
//! types. By default these types are parsed to `string` types with additional `format` information.
//! `format: date-time` for `DateTime` and `format: date` for `Date` and `NaiveDate` according
//! [RFC3339](https://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14) as `ISO-8601`. To
//! override default `string` representation users have to use `value_type` attribute to override the type.
//! See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
//! * **time** Add support for [time](https://crates.io/crates/time) `OffsetDateTime`, `PrimitiveDateTime`, `Date`, and `Duration` types.
//! By default these types are parsed as `string`. `OffsetDateTime` and `PrimitiveDateTime` will use `date-time` format. `Date` will use
//! `date` format and `Duration` will not have any format. To override default `string` representation users have to use `value_type` attribute
//! to override the type. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
//! * **decimal** Add support for [rust_decimal](https://crates.io/crates/rust_decimal) `Decimal` type. **By default**
//! it is interpreted as `String`. If you wish to change the format you need to override the type.
//! See the `value_type` in [`ToSchema` derive docs][to_schema_derive].
//! * **uuid** Add support for [uuid](https://github.com/uuid-rs/uuid). `Uuid` type will be presented as `String` with
//! format `uuid` in OpenAPI spec.
//! * **ulid** Add support for [ulid](https://github.com/dylanhart/ulid-rs). `Ulid` type will be presented as `String` with
//! format `ulid` in OpenAPI spec.
//! * **smallvec** Add support for [smallvec](https://crates.io/crates/smallvec). `SmallVec` will be treated as `Vec`.
//! * **openapi_extensions** Adds convenience functions for documenting common scenarios, such as JSON request bodies and responses.
//! See the [`request_body`](https://docs.rs/utoipa/latest/utoipa/openapi/request_body/index.html) and
//! [`response`](https://docs.rs/utoipa/latest/utoipa/openapi/response/index.html) docs for examples.
//! * **repr** Add support for [repr_serde](https://github.com/dtolnay/serde-repr)'s `repr(u*)` and `repr(i*)` attributes to unit type enums for
//! C-like enum representation. See [docs](https://docs.rs/utoipa/latest/utoipa/derive.ToSchema.html) for more details.
//! * **preserve_order** Preserve order of properties when serializing the schema for a component.
//! When enabled, the properties are listed in order of fields in the corresponding struct definition.
//! When disabled, the properties are listed in alphabetical order.
//! * **preserve_path_order** Preserve order of OpenAPI Paths according to order they have been
//! introduced to the `#[openapi(paths(...))]` macro attribute. If disabled the paths will be
//! ordered in alphabetical order.
//! * **indexmap** Add support for [indexmap](https://crates.io/crates/indexmap). When enabled `IndexMap` will be rendered as a map similar to
//! `BTreeMap` and `HashMap`.
//! * **non_strict_integers** Add support for non-standard integer formats `int8`, `int16`, `uint8`, `uint16`, `uint32`, and `uint64`.
//! * **rc_schema** Add `ToSchema` support for `Arc<T>` and `Rc<T>` types. **Note!** serde `rc` feature flag must be enabled separately to allow
//! serialization and deserialization of `Arc<T>` and `Rc<T>` types. See more about [serde feature flags](https://serde.rs/feature-flags.html).
//!
//! Utoipa implicitly has partial support for `serde` attributes. See [`ToSchema` derive][serde] for more details.
//!
//! # Install
//!
//! Add minimal dependency declaration to Cargo.toml.
//! ```toml
//! [dependencies]
//! utoipa = "3"
//! ```
//!
//! To enable more features such as use actix framework extras you could define the
//! dependency as follows.
//! ```toml
//! [dependencies]
//! utoipa = { version = "3", features = ["actix_extras"] }
//! ```
//!
//! **Note!** To use `utoipa` together with Swagger UI you can use the [`utoipa-swagger-ui`][utoipa_swagger] crate.
//!
//! [utoipa_swagger]: <https://docs.rs/utoipa-swagger-ui/>
//!
//! # Examples
//!
//! Create a struct, or it could be an enum also. Add `ToSchema` derive macro to it so it can be registered
//! as a component in openapi schema.
//! ```rust
//! use utoipa::ToSchema;
//! #[derive(ToSchema)]
//! struct Pet {
//! id: u64,
//! name: String,
//! age: Option<i32>,
//! }
//! ```
//!
//! Create an handler that would handle your business logic and add `path` proc attribute macro over it.
//! ```rust
//! mod pet_api {
//! # use utoipa::ToSchema;
//! #
//! # #[derive(ToSchema)]
//! # struct Pet {
//! # id: u64,
//! # name: String,
//! # age: Option<i32>,
//! # }
//! /// Get pet by id
//! ///
//! /// Get pet from database by pet id
//! #[utoipa::path(
//! get,
//! path = "/pets/{id}",
//! responses(
//! (status = 200, description = "Pet found successfully", body = Pet),
//! (status = NOT_FOUND, description = "Pet was not found")
//! ),
//! params(
//! ("id" = u64, Path, description = "Pet database id to get Pet for"),
//! )
//! )]
//! async fn get_pet_by_id(pet_id: u64) -> Pet {
//! Pet {
//! id: pet_id,
//! age: None,
//! name: "lightning".to_string(),
//! }
//! }
//! }
//! ```
//!
//! Utoipa has support for [http](https://crates.io/crates/http) `StatusCode` in responses.
//!
//! Tie the above component and api to the openapi schema with following `OpenApi` derive proc macro.
//! ```rust
//! # mod pet_api {
//! # use utoipa::ToSchema;
//! #
//! # #[derive(ToSchema)]
//! # struct Pet {
//! # id: u64,
//! # name: String,
//! # age: Option<i32>,
//! # }
//! #
//! # /// Get pet by id
//! # ///
//! # /// Get pet from database by pet id
//! # #[utoipa::path(
//! # get,
//! # path = "/pets/{id}",
//! # responses(
//! # (status = 200, description = "Pet found successfully", body = Pet),
//! # (status = 404, description = "Pet was not found")
//! # ),
//! # params(
//! # ("id" = u64, Path, description = "Pet database id to get Pet for"),
//! # )
//! # )]
//! # async fn get_pet_by_id(pet_id: u64) -> Pet {
//! # Pet {
//! # id: pet_id,
//! # age: None,
//! # name: "lightning".to_string(),
//! # }
//! # }
//! # }
//! # use utoipa::ToSchema;
//! #
//! # #[derive(ToSchema)]
//! # struct Pet {
//! # id: u64,
//! # name: String,
//! # age: Option<i32>,
//! # }
//! use utoipa::OpenApi;
//! #[derive(OpenApi)]
//! #[openapi(paths(pet_api::get_pet_by_id), components(schemas(Pet)))]
//! struct ApiDoc;
//!
//! println!("{}", ApiDoc::openapi().to_pretty_json().unwrap());
//! ```
//!
//! # Modify OpenAPI at runtime
//!
//! You can modify generated OpenAPI at runtime either via generated types directly or using
//! [`Modify`] trait.
//!
//! _**Modify generated OpenAPI via types directly.**_
//! ```rust
//! # use utoipa::OpenApi;
//! #[derive(OpenApi)]
//! #[openapi(
//! info(description = "My Api description"),
//! )]
//! struct ApiDoc;
//!
//! let mut doc = ApiDoc::openapi();
//! doc.info.title = String::from("My Api");
//! ```
//!
//! _**You can even convert the generated [`OpenApi`] to [`openapi::OpenApiBuilder`].**_
//! ```rust
//! # use utoipa::openapi::OpenApiBuilder;
//! # use utoipa::OpenApi;
//! #[derive(OpenApi)]
//! #[openapi(
//! info(description = "My Api description"),
//! )]
//! struct ApiDoc;
//!
//! let builder: OpenApiBuilder = ApiDoc::openapi().into();
//! ```
//!
//! See [`Modify`] trait for examples on how to modify generated OpenAPI via it.
//!
//! # Go beyond the surface
//!
//! * See how to serve OpenAPI doc via Swagger UI check [`utoipa-swagger-ui`][utoipa_swagger] crate for more details.
//! * Browse to [examples](https://github.com/juhaku/utoipa/tree/master/examples) for more comprehensive examples.
//! * Check [`derive@IntoResponses`] and [`derive@ToResponse`] for examples on deriving responses.
//! * More about OpenAPI security in [security documentation][security].
//! * Dump generated API doc to file at build time. See [issue 214 comment](https://github.com/juhaku/utoipa/issues/214#issuecomment-1179589373).
//!
//! [path]: attr.path.html
//! [rocket_path]: attr.path.html#rocket_extras-support-for-rocket
//! [actix_path]: attr.path.html#actix_extras-support-for-actix-web
//! [axum_path]: attr.path.html#axum_extras-support-for-axum
//! [serde]: derive.ToSchema.html#partial-serde-attributes-support
//!
//! [security]: openapi/security/index.html
//! [to_schema_derive]: derive.ToSchema.html
pub mod openapi;
use std::collections::{BTreeMap, HashMap};
pub use utoipa_gen::*;
/// Trait for implementing OpenAPI specification in Rust.
///
/// This trait is derivable and can be used with `#[derive]` attribute. The derived implementation
/// will use Cargo provided environment variables to implement the default information. For a details of
/// `#[derive(ToSchema)]` refer to [derive documentation][derive].
///
/// # Examples
///
/// Below is derived example of `OpenApi`.
/// ```rust
/// use utoipa::OpenApi;
/// #[derive(OpenApi)]
/// #[openapi()]
/// struct OpenApiDoc;
/// ```
///
/// This manual `OpenApi` trait implementation is approximately equal to the above derived one except the derive
/// implementation will by default use the Cargo environment variables to set defaults for *application name,
/// version, application description, license, author name & email*.
///
///```rust
/// struct OpenApiDoc;
///
/// impl utoipa::OpenApi for OpenApiDoc {
/// fn openapi() -> utoipa::openapi::OpenApi {
/// use utoipa::{ToSchema, Path};
/// utoipa::openapi::OpenApiBuilder::new()
/// .info(utoipa::openapi::InfoBuilder::new()
/// .title("application name")
/// .version("version")
/// .description(Some("application description"))
/// .license(Some(utoipa::openapi::License::new("MIT")))
/// .contact(
/// Some(utoipa::openapi::ContactBuilder::new()
/// .name(Some("author name"))
/// .email(Some("author email")).build()),
/// ).build())
/// .paths(utoipa::openapi::path::Paths::new())
/// .components(Some(utoipa::openapi::Components::new()))
/// .build()
/// }
/// }
/// ```
/// [derive]: derive.OpenApi.html
pub trait OpenApi {
fn openapi() -> openapi::OpenApi;
}
/// Trait for implementing OpenAPI Schema object.
///
/// Generated schemas can be referenced or reused in path operations.
///
/// This trait is derivable and can be used with `[#derive]` attribute. For a details of
/// `#[derive(ToSchema)]` refer to [derive documentation][derive].
///
/// [derive]: derive.ToSchema.html
///
/// # Examples
///
/// Use `#[derive]` to implement `ToSchema` trait.
/// ```rust
/// # use utoipa::ToSchema;
/// #[derive(ToSchema)]
/// #[schema(example = json!({"name": "bob the cat", "id": 1}))]
/// struct Pet {
/// id: u64,
/// name: String,
/// age: Option<i32>,
/// }
/// ```
///
/// Following manual implementation is equal to above derive one.
/// ```rust
/// # struct Pet {
/// # id: u64,
/// # name: String,
/// # age: Option<i32>,
/// # }
/// #
/// impl<'__s> utoipa::ToSchema<'__s> for Pet {
/// fn schema() -> (&'__s str, utoipa::openapi::RefOr<utoipa::openapi::schema::Schema>) {
/// (
/// "Pet",
/// utoipa::openapi::ObjectBuilder::new()
/// .property(
/// "id",
/// utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::Integer)
/// .format(Some(utoipa::openapi::SchemaFormat::KnownFormat(
/// utoipa::openapi::KnownFormat::Int64,
/// ))),
/// )
/// .required("id")
/// .property(
/// "name",
/// utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::String),
/// )
/// .required("name")
/// .property(
/// "age",
/// utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::Integer)
/// .format(Some(utoipa::openapi::SchemaFormat::KnownFormat(
/// utoipa::openapi::KnownFormat::Int32,
/// ))),
/// )
/// .example(Some(serde_json::json!({
/// "name":"bob the cat","id":1
/// })))
/// .into(),
/// ) }
/// }
/// ```
pub trait ToSchema<'__s> {
/// Return a tuple of name and schema or reference to a schema that can be referenced by the
/// name or inlined directly to responses, request bodies or parameters.
fn schema() -> (&'__s str, openapi::RefOr<openapi::schema::Schema>);
/// Optional set of alias schemas for the [`ToSchema::schema`].
///
/// Typically there is no need to manually implement this method but it is instead implemented
/// by derive [`macro@ToSchema`] when `#[aliases(...)]` attribute is defined.
fn aliases() -> Vec<(&'__s str, openapi::schema::Schema)> {
Vec::new()
}
}
impl<'__s, T: ToSchema<'__s>> From<T> for openapi::RefOr<openapi::schema::Schema> {
fn from(_: T) -> Self {
T::schema().1
}
}
/// Represents _`nullable`_ type. This can be used anywhere where "nothing" needs to be evaluated.
/// This will serialize to _`null`_ in JSON and [`openapi::schema::empty`] is used to create the
/// [`openapi::schema::Schema`] for the type.
pub type TupleUnit = ();
impl<'__s> ToSchema<'__s> for TupleUnit {
fn schema() -> (&'__s str, openapi::RefOr<openapi::schema::Schema>) {
("TupleUnit", openapi::schema::empty().into())
}
}
macro_rules! impl_partial_schema {
( $ty:path ) => {
impl_partial_schema!( @impl_schema $ty );
};
( & $ty:path ) => {
impl_partial_schema!( @impl_schema &$ty );
};
( @impl_schema $( $tt:tt )* ) => {
impl PartialSchema for $($tt)* {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!( $($tt)* ).into()
}
}
};
}
macro_rules! impl_partial_schema_primitive {
( $( $tt:path ),* ) => {
$( impl_partial_schema!( $tt ); )*
};
}
// Create `utoipa` module so we can use `utoipa-gen` directly from `utoipa` crate.
// ONLY for internal use!
#[doc(hidden)]
mod utoipa {
pub use super::*;
}
/// Trait used to implement only _`Schema`_ part of the OpenAPI doc.
///
/// This trait is by default implemented for Rust [`primitive`][primitive] types and some well known types like
/// [`Vec`], [`Option`], [`HashMap`] and [`BTreeMap`]. The default implementation adds `schema()`
/// method to the implementing type allowing simple conversion of the type to the OpenAPI Schema
/// object. Moreover this allows handy way of constructing schema objects manually if ever so
/// wished.
///
/// The trait can be implemented manually easily on any type. This trait comes especially handy
/// with [`macro@schema`] macro that can be used to generate schema for arbitrary types.
/// ```rust
/// # use utoipa::PartialSchema;
/// # use utoipa::openapi::schema::{SchemaType, KnownFormat, SchemaFormat, ObjectBuilder, Schema};
/// # use utoipa::openapi::RefOr;
/// #
/// struct MyType;
///
/// impl PartialSchema for MyType {
/// fn schema() -> RefOr<Schema> {
/// // ... impl schema generation here
/// RefOr::T(Schema::Object(ObjectBuilder::new().build()))
/// }
/// }
/// ```
///
/// # Examples
///
/// _**Create number schema from u64.**_
/// ```rust
/// # use utoipa::PartialSchema;
/// # use utoipa::openapi::schema::{SchemaType, KnownFormat, SchemaFormat, ObjectBuilder, Schema};
/// # use utoipa::openapi::RefOr;
/// #
/// let number: RefOr<Schema> = i64::schema().into();
///
/// // would be equal to manual implementation
/// let number2 = RefOr::T(
/// Schema::Object(
/// ObjectBuilder::new()
/// .schema_type(SchemaType::Integer)
/// .format(Some(SchemaFormat::KnownFormat(KnownFormat::Int64)))
/// .build()
/// )
/// );
/// # assert_json_diff::assert_json_eq!(serde_json::to_value(&number).unwrap(), serde_json::to_value(&number2).unwrap());
/// ```
///
/// _**Construct a Pet object schema manually.**_
/// ```rust
/// # use utoipa::PartialSchema;
/// # use utoipa::openapi::schema::ObjectBuilder;
/// struct Pet {
/// id: i32,
/// name: String,
/// }
///
/// let pet_schema = ObjectBuilder::new()
/// .property("id", i32::schema())
/// .property("name", String::schema())
/// .required("id").required("name")
/// .build();
/// ```
///
/// [primitive]: https://doc.rust-lang.org/std/primitive/index.html
pub trait PartialSchema {
/// Return ref or schema of implementing type that can then be used to
/// construct combined schemas.
fn schema() -> openapi::RefOr<openapi::schema::Schema>;
}
#[rustfmt::skip]
impl_partial_schema_primitive!(
i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize, bool, f32, f64, String, str, char,
Option<i8>, Option<i16>, Option<i32>, Option<i64>, Option<i128>, Option<isize>, Option<u8>, Option<u16>,
Option<u32>, Option<u64>, Option<u128>, Option<usize>, Option<bool>, Option<f32>, Option<f64>,
Option<String>, Option<&str>, Option<char>
);
impl_partial_schema!(&str);
impl<'__s, T: ToSchema<'__s>> PartialSchema for Vec<T> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(#[inline] Vec<T>).into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for Option<Vec<T>> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(#[inline] Option<Vec<T>>).into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for [T] {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
[T]
)
.into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for &[T] {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
&[T]
)
.into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for &mut [T] {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
&mut [T]
)
.into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for Option<&[T]> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
Option<&[T]>
)
.into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for Option<&mut [T]> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
Option<&mut [T]>
)
.into()
}
}
impl<'__s, T: ToSchema<'__s>> PartialSchema for Option<T> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(#[inline] Option<T>).into()
}
}
impl<'__s, K: PartialSchema, V: ToSchema<'__s>> PartialSchema for BTreeMap<K, V> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
BTreeMap<K, V>
)
.into()
}
}
impl<'__s, K: PartialSchema, V: ToSchema<'__s>> PartialSchema for Option<BTreeMap<K, V>> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
Option<BTreeMap<K, V>>
)
.into()
}
}
impl<'__s, K: PartialSchema, V: ToSchema<'__s>> PartialSchema for HashMap<K, V> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
HashMap<K, V>
)
.into()
}
}
impl<'__s, K: PartialSchema, V: ToSchema<'__s>> PartialSchema for Option<HashMap<K, V>> {
fn schema() -> openapi::RefOr<openapi::schema::Schema> {
schema!(
#[inline]
Option<HashMap<K, V>>
)
.into()
}
}
/// Trait for implementing OpenAPI PathItem object with path.
///
/// This trait is implemented via [`#[utoipa::path(...)]`][derive] attribute macro and there
/// is no need to implement this trait manually.
///
/// # Examples
///
/// Use `#[utoipa::path(..)]` to implement Path trait
/// ```rust
/// # struct Pet {
/// # id: u64,
/// # name: String,
/// # }
/// #
/// #
/// /// Get pet by id
/// ///
/// /// Get pet from database by pet database id
/// #[utoipa::path(
/// get,
/// path = "/pets/{id}",
/// responses(
/// (status = 200, description = "Pet found successfully", body = Pet),
/// (status = 404, description = "Pet was not found")
/// ),
/// params(
/// ("id" = u64, Path, description = "Pet database id to get Pet for"),
/// )
/// )]
/// async fn get_pet_by_id(pet_id: u64) -> Pet {
/// Pet {
/// id: pet_id,
/// name: "lightning".to_string(),
/// }
/// }
/// ```
///
/// Example of what would manual implementation roughly look like of above `#[utoipa::path(...)]` macro.
/// ```rust
/// utoipa::openapi::PathsBuilder::new().path(
/// "/pets/{id}",
/// utoipa::openapi::PathItem::new(
/// utoipa::openapi::PathItemType::Get,
/// utoipa::openapi::path::OperationBuilder::new()
/// .responses(
/// utoipa::openapi::ResponsesBuilder::new()
/// .response(
/// "200",
/// utoipa::openapi::ResponseBuilder::new()
/// .description("Pet found successfully")
/// .content("application/json",
/// utoipa::openapi::Content::new(
/// utoipa::openapi::Ref::from_schema_name("Pet"),
/// ),
/// ),
/// )
/// .response("404", utoipa::openapi::Response::new("Pet was not found")),
/// )
/// .operation_id(Some("get_pet_by_id"))
/// .deprecated(Some(utoipa::openapi::Deprecated::False))
/// .summary(Some("Get pet by id"))
/// .description(Some("Get pet by id\n\nGet pet from database by pet database id\n"))
/// .parameter(
/// utoipa::openapi::path::ParameterBuilder::new()
/// .name("id")
/// .parameter_in(utoipa::openapi::path::ParameterIn::Path)
/// .required(utoipa::openapi::Required::True)
/// .deprecated(Some(utoipa::openapi::Deprecated::False))
/// .description(Some("Pet database id to get Pet for"))
/// .schema(
/// Some(utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::Integer)
/// .format(Some(utoipa::openapi::SchemaFormat::KnownFormat(utoipa::openapi::KnownFormat::Int64)))),
/// ),
/// )
/// .tag("pet_api"),
/// ),
/// );
/// ```
///
/// [derive]: attr.path.html
pub trait Path {
fn path() -> &'static str;
fn path_item(default_tag: Option<&str>) -> openapi::path::PathItem;
}
/// Trait that allows OpenApi modification at runtime.
///
/// Implement this trait if you wish to modify the OpenApi at runtime before it is being consumed
/// *(Before `utoipa::OpenApi::openapi()` function returns)*.
/// This is trait can be used to add or change already generated OpenApi spec to alter the generated
/// specification by user defined condition. For example you can add definitions that should be loaded
/// from some configuration at runtime what may not be available during compile time.
///
/// See more about [`OpenApi`][derive] derive at [derive documentation][derive].
///
/// [derive]: derive.OpenApi.html
/// [security_schema]: openapi/security/enum.SecuritySchema.html
///
/// # Examples
///
/// Add custom JWT [`SecuritySchema`][security_schema] to [`OpenApi`][`openapi::OpenApi`].
/// ```rust
/// # use utoipa::{OpenApi, Modify};
/// # use utoipa::openapi::security::{SecurityScheme, HttpBuilder, HttpAuthScheme};
/// #[derive(OpenApi)]
/// #[openapi(modifiers(&SecurityAddon))]
/// struct ApiDoc;
///
/// struct SecurityAddon;
///
/// impl Modify for SecurityAddon {
/// fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
/// openapi.components = Some(
/// utoipa::openapi::ComponentsBuilder::new()
/// .security_scheme(
/// "api_jwt_token",
/// SecurityScheme::Http(
/// HttpBuilder::new()
/// .scheme(HttpAuthScheme::Bearer)
/// .bearer_format("JWT")
/// .build(),
/// ),
/// )
/// .build(),
/// )
/// }
/// }
/// ```
///
/// Add [OpenAPI Server Object][server] to alter the target server url. This can be used to give context
/// path for api operations.
/// ```rust
/// # use utoipa::{OpenApi, Modify};
/// # use utoipa::openapi::Server;
/// #[derive(OpenApi)]
/// #[openapi(modifiers(&ServerAddon))]
/// struct ApiDoc;
///
/// struct ServerAddon;
///
/// impl Modify for ServerAddon {
/// fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
/// openapi.servers = Some(vec![Server::new("/api")])
/// }
/// }
/// ```
///
/// [server]: https://spec.openapis.org/oas/latest.html#server-object
pub trait Modify {
fn modify(&self, openapi: &mut openapi::OpenApi);
}
/// Trait used to convert implementing type to OpenAPI parameters.
///
/// This trait is [derivable][derive] for structs which are used to describe `path` or `query` parameters.
/// For more details of `#[derive(IntoParams)]` refer to [derive documentation][derive].
///
/// # Examples
///
/// Derive [`IntoParams`] implementation. This example will fail to compile because [`IntoParams`] cannot
/// be used alone and it need to be used together with endpoint using the params as well. See
/// [derive documentation][derive] for more details.
/// ```
/// use utoipa::{IntoParams};
///
/// #[derive(IntoParams)]
/// struct PetParams {
/// /// Id of pet
/// id: i64,
/// /// Name of pet
/// name: String,
/// }
/// ```
///
/// Roughly equal manual implementation of [`IntoParams`] trait.
/// ```rust
/// # struct PetParams {
/// # /// Id of pet
/// # id: i64,
/// # /// Name of pet
/// # name: String,
/// # }
/// impl utoipa::IntoParams for PetParams {
/// fn into_params(
/// parameter_in_provider: impl Fn() -> Option<utoipa::openapi::path::ParameterIn>
/// ) -> Vec<utoipa::openapi::path::Parameter> {
/// vec![
/// utoipa::openapi::path::ParameterBuilder::new()
/// .name("id")
/// .required(utoipa::openapi::Required::True)
/// .parameter_in(parameter_in_provider().unwrap_or_default())
/// .description(Some("Id of pet"))
/// .schema(Some(
/// utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::Integer)
/// .format(Some(utoipa::openapi::SchemaFormat::KnownFormat(utoipa::openapi::KnownFormat::Int64))),
/// ))
/// .build(),
/// utoipa::openapi::path::ParameterBuilder::new()
/// .name("name")
/// .required(utoipa::openapi::Required::True)
/// .parameter_in(parameter_in_provider().unwrap_or_default())
/// .description(Some("Name of pet"))
/// .schema(Some(
/// utoipa::openapi::ObjectBuilder::new()
/// .schema_type(utoipa::openapi::SchemaType::String),
/// ))
/// .build(),
/// ]
/// }
/// }
/// ```
/// [derive]: derive.IntoParams.html
pub trait IntoParams {
/// Provide [`Vec`] of [`openapi::path::Parameter`]s to caller. The result is used in `utoipa-gen` library to
/// provide OpenAPI parameter information for the endpoint using the parameters.
fn into_params(
parameter_in_provider: impl Fn() -> Option<openapi::path::ParameterIn>,
) -> Vec<openapi::path::Parameter>;
}
/// This trait is implemented to document a type (like an enum) which can represent multiple
/// responses, to be used in operation.
///
/// # Examples
///
/// ```
/// use std::collections::BTreeMap;
/// use utoipa::{
/// openapi::{Response, ResponseBuilder, ResponsesBuilder, RefOr},
/// IntoResponses,
/// };
///
/// enum MyResponse {
/// Ok,
/// NotFound,
/// }
///
/// impl IntoResponses for MyResponse {
/// fn responses() -> BTreeMap<String, RefOr<Response>> {
/// ResponsesBuilder::new()
/// .response("200", ResponseBuilder::new().description("Ok"))
/// .response("404", ResponseBuilder::new().description("Not Found"))
/// .build()
/// .into()
/// }
/// }
/// ```
pub trait IntoResponses {
/// Returns an ordered map of response codes to responses.
fn responses() -> BTreeMap<String, openapi::RefOr<openapi::response::Response>>;
}
#[cfg(feature = "auto_into_responses")]
impl<T: IntoResponses, E: IntoResponses> IntoResponses for Result<T, E> {
fn responses() -> BTreeMap<String, openapi::RefOr<openapi::response::Response>> {
let mut responses = T::responses();
responses.append(&mut E::responses());
responses
}
}
#[cfg(feature = "auto_into_responses")]
impl IntoResponses for () {
fn responses() -> BTreeMap<String, openapi::RefOr<openapi::response::Response>> {
BTreeMap::new()
}
}
/// This trait is implemented to document a type which represents a single response which can be
/// referenced or reused as a component in multiple operations.
///
/// _`ToResponse`_ trait can also be derived with [`#[derive(ToResponse)]`][derive].
///
/// # Examples
///
/// ```
/// use utoipa::{
/// openapi::{RefOr, Response, ResponseBuilder},
/// ToResponse,
/// };
///
/// struct MyResponse;
///
/// impl<'__r> ToResponse<'__r> for MyResponse {
/// fn response() -> (&'__r str, RefOr<Response>) {
/// (
/// "MyResponse",
/// ResponseBuilder::new().description("My Response").build().into(),
/// )
/// }
/// }
/// ```
///
/// [derive]: derive.ToResponse.html
pub trait ToResponse<'__r> {
/// Returns a tuple of response component name (to be referenced) to a response.
fn response() -> (&'__r str, openapi::RefOr<openapi::response::Response>);
}
#[cfg(test)]
mod tests {
use assert_json_diff::assert_json_eq;
use serde_json::json;
use super::*;
#[cfg(not(feature = "non_strict_integers"))]
#[test]
fn test_partial_schema_strict_integers() {
use assert_json_diff::{assert_json_matches, CompareMode, Config, NumericMode};
for (name, schema, value) in [
(
"i8",
i8::schema(),
json!({"type": "integer", "format": "int32"}),
),
(
"i16",
i16::schema(),
json!({"type": "integer", "format": "int32"}),
),
(
"i32",
i32::schema(),
json!({"type": "integer", "format": "int32"}),
),
(
"i64",
i64::schema(),
json!({"type": "integer", "format": "int64"}),
),
("i128", i128::schema(), json!({"type": "integer"})),
("isize", isize::schema(), json!({"type": "integer"})),
(
"u8",
u8::schema(),
json!({"type": "integer", "format": "int32", "minimum": 0.0}),
),
(
"u16",
u16::schema(),
json!({"type": "integer", "format": "int32", "minimum": 0.0}),
),
(
"u32",
u32::schema(),
json!({"type": "integer", "format": "int32", "minimum": 0.0}),
),
(
"u64",
u64::schema(),
json!({"type": "integer", "format": "int64", "minimum": 0.0}),
),
] {
println!(
"{name}: {json}",
json = serde_json::to_string(&schema).unwrap()
);
let schema = serde_json::to_value(schema).unwrap();
let config = Config::new(CompareMode::Strict).numeric_mode(NumericMode::AssumeFloat);
assert_json_matches!(schema, value, config);
}
}
#[cfg(feature = "non_strict_integers")]
#[test]
fn test_partial_schema_non_strict_integers() {
for (name, schema, value) in [
(
"i8",
i8::schema(),
json!({"type": "integer", "format": "int8"}),
),
(
"i16",
i16::schema(),
json!({"type": "integer", "format": "int16"}),
),
(
"i32",
i32::schema(),
json!({"type": "integer", "format": "int32"}),
),
(
"i64",
i64::schema(),
json!({"type": "integer", "format": "int64"}),
),
("i128", i128::schema(), json!({"type": "integer"})),
("isize", isize::schema(), json!({"type": "integer"})),
(
"u8",
u8::schema(),
json!({"type": "integer", "format": "uint8", "minimum": 0}),
),
(
"u16",
u16::schema(),
json!({"type": "integer", "format": "uint16", "minimum": 0}),
),
(
"u32",
u32::schema(),
json!({"type": "integer", "format": "uint32", "minimum": 0}),
),
(
"u64",
u64::schema(),
json!({"type": "integer", "format": "uint64", "minimum": 0}),
),
] {
println!(
"{name}: {json}",
json = serde_json::to_string(&schema).unwrap()
);
let schema = serde_json::to_value(schema).unwrap();
assert_json_eq!(schema, value);
}
}
#[test]
fn test_partial_schema() {
for (name, schema, value) in [
("bool", bool::schema(), json!({"type": "boolean"})),
("str", str::schema(), json!({"type": "string"})),
("String", String::schema(), json!({"type": "string"})),
("char", char::schema(), json!({"type": "string"})),
(
"f32",
f32::schema(),
json!({"type": "number", "format": "float"}),
),
(
"f64",
f64::schema(),
json!({"type": "number", "format": "double"}),
),
] {
println!(
"{name}: {json}",
json = serde_json::to_string(&schema).unwrap()
);
let schema = serde_json::to_value(schema).unwrap();
assert_json_eq!(schema, value);
}
}
}