UkiApi is a high-performance web framework for Rust, built on top of Axum, focusing on ergonomics, automatic documentation, and type-safe data validation.

• 🚀 High Performance: Built on Axum and Tokio.
• 📝 Automatic Documentation: Built-in Swagger UI and ReDoc (via schemars and custom macros).
• ✅ Data Validation: Seamless integration with validator for request and query parameters.
• 🔗 Type-Safe Routing: Declarative routing using macros like #[get], #[post], etc.
• 🔁 Hot Reload: Automatic recompilation on file changes via --reload.
• 🧩 Middleware: Custom middleware, CORS, logging, compression, and timeout support.
• 📁 Static Files & Uploads: Built-in file serving and multipart upload handling.
• ⏳ Background Tasks: Schedule async tasks to run after the response is sent.
• 🛠️ CLI Tooling: Dedicated CLI for scaffolding and development.

cargo install uki

uki new my-api
cd my-api

uki dev

Or with hot reload:

uki dev --reload

Your API will be running at http://localhost:3000, with interactive docs at http://localhost:3000/docs.

use ukiapi::{get, post, routes, ValidatedJson};
use ukiapi::Json;
use serde::{Deserialize, Serialize};
use validator::Validate;
use schemars::JsonSchema;

#[derive(Clone)]
pub struct AppState {}

#[derive(Serialize, Deserialize, Validate, JsonSchema)]
pub struct CreateItem {
    #[validate(length(min = 1))]
    name: String,
}

#[get("/hello")]
pub async fn hello() -> &'static str {
    "Hello from UkiApi!"
}

#[post("/items")]
pub async fn create_item(ValidatedJson(payload): ValidatedJson<CreateItem>) -> Json<serde_json::Value> {
    Json(json!({ "item": payload.name }))
}

#[ukiapi::main]
async fn main() {
    let state = AppState {};

    routes![AppState,
        hello_route().with_state::<AppState>(),
        create_item_route().with_state::<AppState>()
    ]
    .serve(state)
    .await;
}

• ukiapi: Core library providing routing, extractors, and types.
• ukiapi-macros: Procedural macros for routing and models.
• uki: Command-line interface for managing UkiApi projects.
• example: A reference implementation demonstrating all features.

We welcome contributions! Please see our Contributing Guidelines for details.

MIT