API Reference

Oxide is a set of Rust crates — the full API is documented inline via rustdoc. Generate it locally with a single command:

# From the framework repo root
cargo doc --no-deps --workspace --open

--no-deps — skips generating documentation for dependencies.
--workspace — includes every oxide-* crate.
--open — opens the rendered site in your default browser.

Output lands at target/doc/index.html. From there you can navigate to any specific crate:

oxide_core — IoC container, service providers
oxide_config — TOML + env loader
oxide_http — HTTP server, routing, middleware
oxide_db — SeaORM integration, migrations
oxide_auth — tokens, hash, abilities
oxide_macros — #[controller], #[api_resource], #[injectable], #[request]
oxide_cli — CLI binary entry points

Inside a consumer project

When you depend on Oxide as a git dep, you can still generate the API docs the same way — cargo will include oxide-* in the doc output:

cargo doc --no-deps --open

The oxide-* crate docs appear in target/doc/oxide_http/, etc.

Hosted rustdoc

Not currently served alongside this docs site. When Oxide publishes to crates.io the usual docs.rs rendering will be available for each crate. Until then, cargo doc --no-deps locally is the authoritative reference.

The source is the specification

Every public type, function, and macro carries a rustdoc comment. Where this guide and the rustdoc differ, the rustdoc is authoritative — it is generated from the same source that cargo compiles.