EmbedIO-Neo.JsonServer 2.17.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package EmbedIO-Neo.JsonServer --version 2.17.0
                    
NuGet\Install-Package EmbedIO-Neo.JsonServer -Version 2.17.0
                    
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="EmbedIO-Neo.JsonServer" Version="2.17.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EmbedIO-Neo.JsonServer" Version="2.17.0" />
                    
Directory.Packages.props
<PackageReference Include="EmbedIO-Neo.JsonServer" />
                    
Project file
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 EmbedIO-Neo.JsonServer --version 2.17.0
                    
#r "nuget: EmbedIO-Neo.JsonServer, 2.17.0"
                    
#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 EmbedIO-Neo.JsonServer@2.17.0
                    
#: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=EmbedIO-Neo.JsonServer&version=2.17.0
                    
Install as a Cake Addin
#tool nuget:?package=EmbedIO-Neo.JsonServer&version=2.17.0
                    
Install as a Cake Tool

EmbedIO-Neo

NuGet version Downloads CI Security Malware scan OpenSSF Scorecard License: MIT

HTTP/1.1: supported HTTP/2: supported HTTP/3: supported

EmbedIO-Neo

A small, modular web server for .NET. EmbedIO-Neo lets you add JSON APIs, static files and WebSockets to desktop apps, local tools and services.

Upgrading? Coming from the original EmbedIO 3.x, start with the upgrade checklist. Already on EmbedIO-Neo v1, read the v1-to-v2 migration guide.

Overview

V2 uses an independently authored HTTP engine with HTTP/1.1, HTTP/2 and HTTP/3 protocol implementations. The Microsoft HttpListener and Mono-derived listener backends have been removed. Applications retain the EmbedIO namespaces and modular request pipeline.

  • JSON callbacks and attribute-based Web API controllers.
  • Static, embedded and ZIP-backed files, including conditional requests and ranges.
  • Managed WebSockets, sessions, CORS and server-sent events.
  • Opt-in bearer authentication, controller roles and policies, with a separate JWT adapter.
  • Bounded authenticated tus uploads with checksums and process-restart recovery (2.12.0+).
  • HTTPS with an application-supplied certificate.
  • Informational responses, trailers and optional capsule/tunnel APIs.
  • Async I/O and graceful drain, with documented protocol and platform limits.

Protocols and platforms

Capability Support
HTTP/1.1 Default TCP listener; HTTP and HTTPS.
HTTP/2 Cleartext prior knowledge and HTTPS with ALPN. TLS negotiation requires the .NET 10 asset.
HTTP/3 HTTPS over QUIC/UDP.
Combined hosting HTTP/1.1 and HTTP/2 over TCP alongside HTTP/3 over UDP on the same HTTPS endpoint.
WebSockets HTTP/1.1 upgrade and negotiated extended CONNECT on modern transports.

The library targets .NET 10 and .NET Standard 2.0. Windows, Linux and macOS have desktop regression coverage. The retained .NET Standard asset has separate compatibility evidence; it does not provide HTTP/3 or establish support for every older runtime. Mobile and sandboxed applications need their platform-specific network permissions and deployment setup.

See the HTTP/3 guide, HTTPS guide and platform documentation for configuration.

Installation

The package ID is EmbedIO-Neo; the assembly and C# namespaces remain EmbedIO.

dotnet add package EmbedIO-Neo

To build from source, use the SDK selected by global.json and reference src/EmbedIO/EmbedIO.csproj from your application.

Usage

This complete console program exposes a JSON endpoint at http://localhost:9696/api/status. Press Ctrl+C to stop.

using System;
using System.Threading;
using EmbedIO;

using var shutdown = new CancellationTokenSource();
Console.CancelKeyPress += (_, args) =>
{
    args.Cancel = true;
    shutdown.Cancel();
};

using var server = new WebServer("http://localhost:9696/")
    .OnGet("/api/status", context => context.SendDataAsync(new { status = "ok" }));

try
{
    await server.RunAsync(shutdown.Token);
}
catch (OperationCanceledException) when (shutdown.IsCancellationRequested)
{
}

OnGet matches a base path, including requests beneath it. Use controllers for exact routes and parameters. To serve files, add WithStaticFolder("/", directory, true) after your API modules; mount order determines which module handles a request.

Guides and tools

Task Documentation
Read request bodies and define routes Requests and controllers
Serve HTML and files Static files
Configure HTTPS Certificates and client trust
Protect APIs and uploads Bearer authentication, policies and optional JWT
Use WebSockets Startup and readiness
Stream progress to a browser Server-sent events
Send interim responses or trailers Response field sections
Accept a capsule tunnel Tunnel ownership and authorization
Run a command-line server CLI and plugins
Serve a JSON file as REST collections JsonServer integration
Build an app with an AI coding agent Agent primer

Browse the documentation index for additional usage, platform and compatibility guides.

Upgrading

From the original EmbedIO 3.x

EmbedIO-Neo carries the archived unosquare/embedio forward. Namespaces, assembly names and the fluent WebServer pipeline are unchanged, so most applications move by swapping packages, replacing SWAN and rebuilding. Work through the upgrade checklist: it lists each change in order, with links into the detailed guides.

From EmbedIO-Neo v1 to v2

Read the Neo v1-to-v2 migration guide. It covers listener removal, approved API changes, stricter request and response framing, response statuses, connection reuse and deployment changes. Rebuild dependent assemblies and test your application's routes and clients before upgrading.

Contributing and license

Report issues and submit pull requests at WilliamSmithEdward/embedio-neo. See CONTRIBUTING.md for pinned tooling and validation commands.

Maintained by William Smith. EmbedIO-Neo is an independent continuation of EmbedIO, licensed under MIT. Original copyrights and third-party notices are preserved. The engine development record contains conformance, performance evidence and remaining acceptance work.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 is compatible.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.19.1 114 10/31/2026
2.19.0 113 10/28/2026
2.18.0 104 10/24/2026
2.17.0 108 10/23/2026
2.16.1 113 10/22/2026
2.16.0 105 10/19/2026
2.15.0 99 10/19/2026
2.14.0 114 10/19/2026
2.13.0 109 10/18/2026
2.12.0 117 10/18/2026
2.11.0 102 10/18/2026
2.10.0 110 10/18/2026
2.9.0 106 10/17/2026
2.8.0 119 10/17/2026
2.7.0 110 10/17/2026
2.6.0 117 10/17/2026
2.5.0 115 10/17/2026
2.4.0 102 10/17/2026
2.3.0 112 10/16/2026
2.2.0 111 10/16/2026
Loading failed