ohkami 0.11.2

Features

• macro free, declarative APIs
• multi runtime support：tokio, async-std (and more in future)

Quick start

1. Add to dependencies :

# This sample uses `tokio` runtime.
# You can choose `async-std` instead by feature "rt_async-std".

[dependencies]
ohkami = { version = "0.11.2", features = ["rt_tokio"] }
tokio  = { version = "1",      features = ["full"] }

2. Write your first code with ohkami : eamples/quick_start

use ohkami::prelude::*;
use ohkami::typed::{OK, NoContent};

async fn health_check() -> NoContent {
    NoContent
}

async fn hello(name: &str) -> OK<String> {
    OK(format!("Hello, {name}!"))
}

#[tokio::main]
async fn main() {
    Ohkami::new((
        "/healthz"
            .GET(health_check),
        "/hello/:name"
            .GET(hello),
    )).howl(3000).await
}

3. Run and check the behavior :

$ cargo run

$ curl http://localhost:3000/healthz
$ curl http://localhost:3000/hello/your_name
Hello, your_name!

Snippets

handle path params

use ohkami::prelude::*;

#[tokio::main]
async fn main() {
    Ohkami::new((
        "/api/hello/:name"
            .GET(hello),
    )).howl("localhost:5000").await
}

async fn hello(name: &str) -> impl IntoResponse {
    format!("Hello, {name}!")
}

handle query params / request body

use ohkami::prelude::*;
use ohkami::typed;   // <--

#[typed::Query]
struct SearchQuery<'q> {
    q: &'q str,
}

async fn search(condition: SearchQuery<'_>) -> OK<String> {
    OK(format!("Something found"))
}

#[typed::Payload(JSOND)]
struct CreateUserRequest<'req> {
    #[serde(rename = "username")]
    name:     &'req str,
    password: &'req str,
}

#[typed::ResponseBody(JSONS)]
struct User {
    name: String,
}

async fn create_user(body: CreateUserRequest<'_>) -> Created<User> {
    Created(User {
        name: format!("ohkami web framework")
    })
}

#[Query], #[Payload( 〜 )] implements FromRequest trait for the struct.

( with path params : ({path params}, {FromRequest values...}) )

use middlewares

ohkami's middlewares are called "fangs".

use ohkami::prelude::*;

struct AppendHeaders;
impl IntoFang for AppendHeaders {
    fn into_fang(self) -> Fang {
        Fang(|res: &mut Response| {
            res.headers.set()
                .Server("ohkami");
        })
    }
}

struct Log;
impl IntoFang for Log {
    fn into_fang(self) -> Fang {
        Fang(|res: &Response| {
            println!("{res:?}");
        })
    }
}

#[tokio::main]
async fn main() {
    Ohkami::with((AppendHeaders, Log), (
        "/".GET(|| async {"Hello!"})
    )).howl(":8080").await
}

Fang schema :

To make a back fang :

• Fn({&/&mut Response})
• Fn(Response) -> Response

To make a front fang :

• Fn()
• Fn({&/&mut Request})
• or _ -> Result<(), Response> version of them (for early returning an error response)

pack of Ohkamis

use ohkami::prelude::*;
use ohkami::typed::{Created, NoContent, ResponseBody};

#[ResponseBody(JSONS)]
struct User {
    name: String
}

async fn create_user() -> Created<User> {
    Created(User {
        name: "ohkami web framework".to_string()
    })
}

async fn health_check() -> NoContent {
    NoContent
}

#[tokio::main]
async fn main() {
    // ...

    let users_ohkami = Ohkami::new((
        "/".POST(create_user),
    ));

    Ohkami::new((
        "/healthz"  .GET(health_check),
        "/api/users".By(users_ohkami), // <-- nest by `By`
    )).howl(5000).await
}

testing

use ohkami::prelude::*;
use ohkami::testing::*; // <--

fn hello_ohkami() -> Ohkami {
    Ohkami::new((
        "/hello".GET(|| async move {
            OK("Hello, world!")
        })
    ))
}

#[tokio::main]
async fn main() {
    hello_ohkami()
        .howl(5050).await
}

#[cfg(test)]
#[tokio::test]
async fn test_my_ohkami() {
    let hello_ohkami = hello_ohkami();

    let res = hello_ohkami.oneshot(TestRequest::GET("/")).await;
    assert_eq!(res.status, http::Status::NotFound);

    let res = hello_ohkami.oneshot(TestRequest::GET("/hello")).await;
    assert_eq!(res.status, http::Status::OK);
    assert_eq!(res.content.unwrap().text(), Some("Hello, world!"));
}

License

ohkami is licensed under MIT LICENSE (LICENSE-MIT or https://opensource.org/licenses/MIT).