yerpc is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the `generate-base-types` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install yerpc

It will make the generate-base-types command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall yerpc uninstalls.

Adding `yerpc` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add yerpc

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

yerpc = "0.6.4"

The yerpc library will be automatically available globally. Read the yerpc library documentation.

Back to the crate overview.

Readme

yerpc

A JSON-RPC 2.0 server handler for Rust, with automatic generation of a TypeScript client.

yerpc includes (optional) integration with axum and tokio-tungstenite for easy setup and usage. Enable the support-axum and support-tungstenite feature flags for these integrations.

Example

use axum::{
    extract::ws::WebSocketUpgrade, http::StatusCode, response::Response, routing::get, Router,
};
use std::net::SocketAddr;
use yerpc::{rpc, RpcClient, RpcSession};
use yerpc::axum::handle_ws_rpc;

struct Api;

#[rpc(all_positional, ts_outdir = "typescript/generated", openrpc_outdir = "./")]
impl Api {
    async fn shout(&self, msg: String) -> String {
        msg.to_uppercase()
    }
    async fn add(&self, a: f32, b: f32) -> f32 {
        a + b
    }
}

#[tokio::main]
async fn main() -> Result<(), std::io::Error> {
    let api = Api {}
    let app = Router::new()
        .route("/rpc", get(handler))
        .layer(Extension(api));
    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    eprintln!("listening on {}", addr);
    axum::Server::bind(&addr)
        .serve(app.into_make_service())
        .await
        .unwrap();

    Ok(())
}

async fn handler(
    ws: WebSocketUpgrade,
    Extension(api): Extension<Api>,
) -> Response {
    let (client, out_channel) = RpcClient::new();
    let session = RpcSession::new(client, api);
    handle_ws_rpc(ws, out_channel, session).await
}

Now you can connect any JSON-RPC client to ws://localhost:3000/rpc and call the shout and add methods.

After running cargo test you will find an autogenerated TypeScript client in the typescript/generated folder and an openrpc.json file in the root fo your project. See examples/axum for a full usage example with Rust server and TypeScript client for a chat server.

Installing the generate-base-types executable

Adding yerpc library as a dependency

Installing the `generate-base-types` executable

Adding `yerpc` library as a dependency