52 releases (15 breaking)

new 0.16.0 Apr 14, 2024
0.15.0 Feb 20, 2024
0.14.0 Feb 16, 2024
0.10.0 Oct 28, 2023
0.6.3 Dec 30, 2022

#71 in HTTP server

Download history 11/week @ 2024-02-03 63/week @ 2024-02-10 901/week @ 2024-02-17 73/week @ 2024-02-24 3/week @ 2024-03-02 11/week @ 2024-03-09 3/week @ 2024-03-16 141/week @ 2024-03-30 48/week @ 2024-04-06

194 downloads per month

MIT license

420KB
10K SLoC

ohkami

ohkami - [狼] wolf in Japanese - is intuitive and declarative web framework.

  • macro-less and type-safe APIs for intuitive and declarative code
  • multi runtime support:tokio, async-std
License build check status of ohkami crates.io

Quick Start

  1. Add to dependencies :
# This sample uses `tokio` runtime.
# `async-std` is available by feature "rt_async-std".

[dependencies]
ohkami = { version = "0.16", features = ["rt_tokio"] }
tokio  = { version = "1",    features = ["full"] }
  1. Write your first code with ohkami : examples/quick_start
use ohkami::prelude::*;
use ohkami::typed::status::NoContent;

async fn health_check() -> NoContent {
    NoContent
}

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

#[tokio::main]
async fn main() {
    Ohkami::new((
        "/healthz"
            .GET(health_check),
        "/hello/:name"
            .GET(hello),
    )).howl("localhost:3000").await
}
  1. 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) -> String {
    format!("Hello, {name}!")
}

Handle request body / query params

use ohkami::prelude::*;
use ohkami::typed::status::Created;

use ohkami::typed::{Query, Payload};
use ohkami::builtin::payload::JSON;

/* `serde = 〜` is not needed in your [dependencies] */
use ohkami::serde::{Serialize, Deserialize};

/* Payload + Deserialize for request */
#[Payload(JSON)]
#[derive(Deserialize)]
struct CreateUserRequest<'req> {
    name:     &'req str,
    password: &'req str,
}

/* Payload + Serialize for response */
#[Payload(JSON)]
#[derive(Serialize)]
struct User {
    name: String,
}

async fn create_user(body: CreateUserRequest<'_>) -> Created<User> {
    Created(User {
        name: String::from("ohkami")
    })
}

#[Query] /* Params like `?lang=rust&q=framework` */
struct SearchQuery<'q> {
    lang:    &'q str,
    #[query(rename = "q")] /* #[serde]-compatible #[query] attribute */
    keyword: &'q str,
}

#[Payload(JSON / S)] /* Shorthand for Payload + Serialize */
struct SearchResult {
    title: String,
}

async fn search(condition: SearchQuery<'_>) -> Vec<SearchResult> {
    vec![
        SearchResult { title: String::from("ohkami") },
    ]
}

Use middlewares

ohkami's request handling system is called "fangs", and middlewares are implemented on this :

use ohkami::prelude::*;


/* Full impl */

use ohkami::{Fang, FangProc};

struct GreetingFang;
impl<I: FangProc> Fang<I> for GreetingFang {
    type Proc = GreetingFangProc<I>;
    fn chain(&self, inner: I) -> Self::Proc {
        GreetingFangProc { inner }
    }
}
struct GreetingFangProc<I: FangProc> {
    inner: I
}
impl<I: FangProc> FangProc for GreetingFangProc<I> {
    async fn bite<'b>(&'b self, req: &'b mut Request) -> Response {
        println!("Welcome, request!: {req:?}");
        let res = self.inner.bite(req).await;
        println!("Go, response!: {res:?}");
        res
    }
}


/* Easy impl with an utility */

#[derive(Clone)]
struct GreetingFang2;
impl FangAction for GreetingFang2 {
    async fn fore<'a>(&'a self, req: &'a mut Request) -> Result<(), Response> {
        println!("Welcomm request!: {req:?}");
        Ok(())
    }
    async fn back<'a>(&'a self, res: &'a mut Response) {
        println!("Go, response!: {res:?}");
    }
}


#[tokio::main]
async fn main() {
    Ohkami::with((
        GreetingFang,
        GreetingFang2,
    ), (
        "/".GET(|| async {"Hello, fangs!"})
    )).howl("localhost:3000").await
}

Pack of Ohkamis

use ohkami::prelude::*;
use ohkami::typed::status::{Created, NoContent};
use ohkami::typed::Payload;
use ohkami::builtin::payload::JSON;

#[Payload(JSON/S)]
struct User {
    name: String
}

async fn list_users() -> Vec<User> {
    vec![
        User { name: String::from("actix") },
        User { name: String::from("axum") },
        User { name: String::from("ohkami") },
    ]
}

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

async fn health_check() -> NoContent {
    NoContent
}

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

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

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

Testing

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

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

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

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

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

Supported protocols

  • HTTPS
  • HTTP/1.1
  • HTTP/2
  • HTTP/3
  • WebSocket

MSRV (Minimum Supported Rust Version)

Latest stable at the time of publication.

License

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

Dependencies

~2–15MB
~175K SLoC