ohkami 0.1.9

simple and non macro-based web framework
Documentation

ohkami - [狼] means wolf in Japanese - is simple and non macro-based web framework for Rust.

Features

  • simple: Less things to learn / Less code to write / Less time to hesitate.
  • non macro-based: No need for using macros.
  • async handlers
  • easy error handling

Quick start

  1. Add dependencies:
[dependencies]
ohkami = "0.1"
  1. Write your first code with ohkami:
use ohkami::prelude::*;

fn main() -> Result<()> {
    Server::setup()
        .GET("/", |_| async {Response::OK("Hello, world!")})
        .serve_on(":3000")
}
  1. If you're interested in ohkami, learn more by examples and documentations(WIP)!

Snippets

get path param

let param: Option<&str> = ctx.param();
// current ohkami only supports single path param at the end of a path

get query param

let query: Option<&str> = ctx.query("key");

deserialize request body

let body: Result<D> = ctx.body::<D>();

return OK response with text/plain

Response::OK("Hello, world!")

return OK response with application/json

Response::OK(JSON("Hello, world!"))

Response::OK(json!("ok": true))

Response::OK(json(user)?) // serialize Rust value into JSON

error handling

let count = ctx.query("count")
    ._else(|| Response::BadRequest("expected query param `count`"))?
    .parse::<usize>()
    ._else(|_| Response::BadRequest("`count` must be an integer"))?;

let user = ctx.body::<User>()?;
// `Response` implements `From<serde_json::Error>`

// or, you can add an error context message:
let user = ctx.body::<User>()
    ._else(|e| e.error_context("failed to get user data"))?;

Development

ohkami is on very early stage now and not for producntion use.

License

This project is under MIT LICENSE (LICENSE-MIT or https://opensource.org/licenses/MIT).