This documentation is deprecated. It covers rspc 0.3.0, which is no longer maintained.
Quickstart
Choose a complete guide for the API your application uses.
This archived alpha quickstart mixed proposed APIs with the released router API. Use a complete, version-specific setup instead:
- For
rspc = "0.3.0", follow the 0.3.0 quickstart. It includes an Axum server, binding export, a router test, and a frontend call. - For the experimental
Procedure::builderrewrite, follow the next API quickstart. It pins the source revision used by those examples.
Check an existing application
Look at the router constructor and dependency lockfile before copying code:
| Code in your application | Guide |
|---|---|
Router::new().query("name", ...) | 0.3.0 router API |
Router::new().procedure("name", ...) | Experimental procedure API |
Do not update Specta independently of rspc. The released API and the rewrite require older Specta release candidates with APIs that differ from the current standalone Specta docs.
Verify the setup
Build the router in a test, generate bindings before frontend type checking, and run one request through the real adapter. A successful Rust build does not prove that a frontend transport speaks the adapter's protocol.
Last updated on