6 releases
0.2.0 | Aug 7, 2024 |
---|---|
0.1.4 | Jul 18, 2024 |
0.1.3 | Apr 29, 2023 |
0.1.2 | Mar 7, 2023 |
0.1.0 | Jul 10, 2022 |
#57 in #swagger
14,844 downloads per month
Used in okapi-operation
47KB
1K
SLoC
okapi-operation
Library which allow to generate OpenAPI's operation definitions (using types from okapi
crate) with procedural
macro #[openapi]
.
Example (with axum-integration feature).
use axum::{extract::Query, Json};
use okapi_operation::{axum_integration::*, *};
use serde::Deserialize;
#[derive(Deserialize, JsonSchema)]
struct Request {
/// Echo data
data: String,
}
#[openapi(
summary = "Echo using GET request",
operation_id = "echo_get",
tags = "echo",
parameters(
query(name = "echo-data", required = true, schema = "std::string::String",),
header(name = "x-request-id", schema = "std::string::String",)
)
)]
async fn echo_get(query: Query<Request>) -> Json<String> {
Json(query.0.data)
}
#[openapi(
summary = "Echo using POST request",
operation_id = "echo_post",
tags = "echo"
)]
async fn echo_post(
#[body(description = "Echo data", required = true)] body: Json<Request>,
) -> Json<String> {
Json(body.0.data)
}
fn main() {
let app = Router::new()
.route("/echo/get", get(openapi_handler!(echo_get)))
.route("/echo/post", post(openapi_handler!(echo_post)))
.finish_openapi("/openapi", "Demo", "1.0.0")
.expect("no problem");
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
axum::serve(listener, app.into_make_service()).await.unwrap()
}
Features
macro
: enables re-import of#[openapi]
macro (enabled by default);axum-integration
: enables integration withaxum
(https://github.com/tokio-rs/axum) crate (implement traits for certainaxum
types):- Compatibility with
axum
: since integration heavely rely onaxum
types, this crate will be compatible only with few (maybe even one) last versions ofaxum
; - Currently supported
axum
versions:0.7.x
.
- Compatibility with
yaml
: enables ability to serve the spec in yaml format in case of presentAccept
header withyaml
value. Otherwise, in case of valuesjson|*/*
or empty,json
's being served (currently affects onlyaxum-integration
).
TODO
- support examples on MediaType or Parameter (examples supported on types via
JsonSchema
macro) - support inferring schemas of parameters from function definitions
- support for renaming or changing paths to okapi/schemars/okapi-operations in macro
- more examples
- ...
Dependencies
~0.6–1.1MB
~24K SLoC