#openapi #swagger #axum #rust

macro okapi-operation-macro

Macro implementation for okapi-operation

4 releases

0.1.3 Apr 29, 2023
0.1.2 Mar 7, 2023
0.1.1 Aug 6, 2022
0.1.0 Jul 10, 2022

#54 in #swagger

Download history 847/week @ 2023-10-19 850/week @ 2023-10-26 959/week @ 2023-11-02 1027/week @ 2023-11-09 682/week @ 2023-11-16 607/week @ 2023-11-23 670/week @ 2023-11-30 662/week @ 2023-12-07 661/week @ 2023-12-14 390/week @ 2023-12-21 148/week @ 2023-12-28 488/week @ 2024-01-04 630/week @ 2024-01-11 651/week @ 2024-01-18 709/week @ 2024-01-25 859/week @ 2024-02-01

3,019 downloads per month
Used in okapi-operation

MIT license

40KB
989 lines

okapi-operation

Crates.io docs.rs CI

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(
    #[request_body(description = "Echo data", required = true)] body: Json<Request>,
) -> Json<String> {
    Json(body.0.data)
}

fn main() {
    // Here you can also add security schemes, other operations, modify internal OpenApi object.
    let oas_builder = OpenApiBuilder::new("Demo", "1.0.0");
    
    let app = Router::new()
        .route("/echo/get", get(openapi_handler!(echo_get)))
        .route("/echo/post", post(openapi_handler!(echo_post)))
        .route_openapi_specification("/openapi", oas_builder)
        .expect("no problem");

    let fut = async {
        axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
            .serve(app.into_make_service())
            .await
            .unwrap();
    };
    //tokio::runtime::Runtime::new().block_on(fut);
}

Features

  • macro: enables re-import of #[openapi] macro (enabled by default);
  • axum-integration: enables integration with axum(https://github.com/tokio-rs/axum) crate (implement traits for certain axum types):
    • Compatibility with axum: since integration heavely rely on axum types, this crate will be compatible only with few (maybe even one) last versions of axum;
    • Currently supported axum versions: 0.6.x.

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

~1.5MB
~40K SLoC