#response #okapi #structs #macro #typing #okapi-rocket-response-inner

okapi-response-mac

A macro for creating response code based on responses structs rather than typing and implementing OkapiRocketResponseInner manually

2 releases

0.1.1 Oct 24, 2024
0.1.0 Oct 19, 2024

#650 in Rust patterns

Download history 167/week @ 2024-10-14 140/week @ 2024-10-21 9/week @ 2024-10-28 3/week @ 2024-11-04

319 downloads per month

MIT license

17KB
274 lines

Okapi Response macro crate

A single macro for creating response code based on responses structs for cases in which it would be ok to avoid implementing OkapiRocketResponseInner manually.

Make strongly typed Rocket responses while simultaneously adding to your openapi.json definitions.

Usage

Example 1 Uses three different structs that you could potentially return at an endpoint.
Also, the last bit of the macro pattern -> (500,501) indicates the responses that will be of type string.
It is not required for your business requirements, but it is for this macro. You would need to respond an empty tuple -> ().

Note: usage requires the "paste" crate to be imported.

use rocket::get;
use rocket_okapi::openapi;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use okapi_response_mac::okapi_rocket_response;
use paste::paste;
use rocket::serde::json::Json;

#[derive(Default, JsonSchema, Serialize)]
pub struct A {
    name: String,
    email: String,
    other: String,
    things: String,
    blah: u32,
}
#[derive(JsonSchema, Serialize)]
pub struct B {
    name: String,
    email: String,
}
#[derive(Serialize, JsonSchema)]
pub struct C {
    name: String,
    email: String,
}


okapi_rocket_response!(A : (Ok, 200, "application/json"), (Accept, 202, "application/json") ->
    B :  (Create, 203, "application/json") -> C : (NotFound, 404, "application/json") -> (500,501));

/// Creates documentation for OpenApi
#[openapi(tag = "User Versions")]
#[get("/")]
pub fn schema_derived() ->  ABCR {
    ABCR::Ok(Json::from(A {
        name: "asdfasdf".to_string(),
        email: "asdgasdg".to_string(),
        other: "hghsfghs".to_string(),
        things: "ertret".to_string(),
        blah: 0,
    }))
}

It combines your struct names into a single Enum followed by R to indicate a valid Rocket Response.

No runtime deps