boson-axum 0.1.1

HTTP admin API for Boson under /api/boson
Documentation

boson-axum

HTTP admin API for Boson under /api/boson.

Role

  • Job enqueue, list, get, and cancel
  • Run inspection and task config CRUD
  • boson_router — mountable Axum router
  • BosonState — shared handler state (FromRef into host router)

Mount

use axum::Router;
use boson_axum::{boson_router, BosonState, NEST_PATH};

let app = Router::new()
    .nest(NEST_PATH, boson_router())
    .with_state(BosonState { boson: shared_boson });

Enable via the boson crate's axum feature:

boson = { package = "uf-boson", version = "0.1.1", features = ["mem", "axum"] }

Routes

Method Path Purpose
POST /jobs/enqueue Enqueue a job
GET /jobs List jobs
GET /jobs/{id} Get job by id
POST /jobs/{id}/cancel Cancel job
GET /runs List runs
GET /tasks List registered tasks
GET/PUT /tasks/{name}/config Task configuration

Related crates

  • boson — enable with features = ["axum"]
  • boson-runtime — Boson instance wired into state