RpcToolkit.AspNetCore
1.1.6
dotnet add package RpcToolkit.AspNetCore --version 1.1.6
NuGet\Install-Package RpcToolkit.AspNetCore -Version 1.1.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RpcToolkit.AspNetCore" Version="1.1.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RpcToolkit.AspNetCore" Version="1.1.6" />
<PackageReference Include="RpcToolkit.AspNetCore" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RpcToolkit.AspNetCore --version 1.1.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: RpcToolkit.AspNetCore, 1.1.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RpcToolkit.AspNetCore@1.1.6
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RpcToolkit.AspNetCore&version=1.1.6
#tool nuget:?package=RpcToolkit.AspNetCore&version=1.1.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
RPC .NET Toolkit
JSON-RPC 2.0 toolkit for .NET applications. It provides a server endpoint, typed C# client, batch requests, Safe Mode serialization, middleware, and method-level authorization.
Packages
Install the core package from NuGet:
dotnet add package RpcToolkit
For ASP.NET Core hosting, install the adapter package:
dotnet add package RpcToolkit.AspNetCore
Target Frameworks
RpcToolkit targets:
netstandard2.0, usable from .NET Framework 4.8 and modern .NETnet6.0net8.0
RpcToolkit.AspNetCore targets ASP.NET Core on modern .NET.
Minimal Endpoint
using RpcToolkit;
var endpoint = new RpcEndpoint();
endpoint.AddMethod<AddParams, int>("calculator.add", (p, ctx) =>
{
return p!.A + p.B;
});
var json = @"{""jsonrpc"":""2.0"",""method"":""calculator.add"",""params"":{""a"":5,""b"":3},""id"":1}";
var response = await endpoint.HandleRequestAsync(json);
public sealed class AddParams
{
public int A { get; set; }
public int B { get; set; }
}
Minimal Client
using RpcToolkit;
using var client = new RpcClient("http://localhost:5000/rpc");
var result = await client.CallAsync<int>("calculator.add", new { a = 5, b = 3 });
Documentation
Start here:
- Getting Started: endpoint, methods, requests, errors.
- Clients: C# client, browser client expectations, auth headers.
- HTTP Hosting: ASP.NET Core and custom
HttpListenerhosts. - Authentication and Authorization: request context,
ClaimsPrincipal, scopes, roles, custom policies. - Safe Mode:
RpcSafeEndpoint,RpcSafeClient, serialization behavior. - Middleware, Batch, Logging: operational features.
Examples:
Core Concepts
- The HTTP host owns ports, paths, TLS,
/health, CORS, and route-level challenges. RpcEndpointandRpcSafeEndpointparse JSON-RPC and invoke registered methods.- Per-request data is passed with
HandleRequestAsync(json, context). - Method authorization belongs in RPC method configuration, because the method is known only after parsing and lookup.
Build
dotnet restore
dotnet build
dotnet test
License
MIT. See LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- RpcToolkit (>= 1.1.5)
-
net8.0
- RpcToolkit (>= 1.1.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.