okapi-operation 0.3.0

Procedural macro for generating OpenAPI operation specification (using okapi)
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

#![allow(rustdoc::bare_urls)]
#![doc = include_str!("../docs/root.md")]

pub use anyhow;
#[doc(no_inline)]
pub use okapi::{
    self,
    openapi3::OpenApi,
    schemars::{self, JsonSchema},
};
#[cfg(feature = "macro")]
#[doc(inline)]
pub use okapi_operation_macro::openapi;

#[cfg(feature = "axum")]
pub mod axum_integration;

use okapi::openapi3::Operation;

pub use self::{
    builder::OpenApiBuilder,
    components::{Components, ComponentsBuilder},
    to_media_types::ToMediaTypes,
    to_responses::ToResponses,
};

mod builder;
mod components;
mod to_media_types;
mod to_responses;

/// Empty type alias (for using in attribute values).
pub type Empty = ();

// TODO: allow return RefOr<Operation>
/// Operation generator signature.
pub type OperationGenerator = fn(&mut Components) -> Result<Operation, anyhow::Error>;

#[cfg(feature = "macro")]
#[doc(hidden)]
pub mod _macro_prelude {
    pub use okapi;

    pub use crate::{Components, ToMediaTypes, ToResponses};
}