RESTworld.AspNetCore
39.0.0
dotnet add package RESTworld.AspNetCore --version 39.0.0
NuGet\Install-Package RESTworld.AspNetCore -Version 39.0.0
<PackageReference Include="RESTworld.AspNetCore" Version="39.0.0" />
<PackageVersion Include="RESTworld.AspNetCore" Version="39.0.0" />
<PackageReference Include="RESTworld.AspNetCore" />
paket add RESTworld.AspNetCore --version 39.0.0
#r "nuget: RESTworld.AspNetCore, 39.0.0"
#:package RESTworld.AspNetCore@39.0.0
#addin nuget:?package=RESTworld.AspNetCore&version=39.0.0
#tool nuget:?package=RESTworld.AspNetCore&version=39.0.0
<img src="logo/RESTworld.svg" alt="RESTworld logo" width="50" /> RESTworld
RESTworld is a developer-focused framework that turns ASP.NET Core and Entity Framework Core into a fully RESTful, HAL-compliant platform. It combines well-known building blocks with batteries-included conventions so you can deliver production-ready APIs quickly.
Key capabilities
- Opinionated pipelines for read and CRUD scenarios, with extensibility hooks when you need to customize.
- Out-of-the-box support for HAL, HAL-FORMS, and OData (query, paging, templated links).
- Mapperly-based mapping, resource-based authorization, and API versioning baked into the request flow.
- Telemetry via OpenTelemetry, health endpoints for readiness/liveness/startup, and Aspire integration for local orchestration.
- An AI agent plugin with skills that help your coding agent build on RESTworld.
Getting started
- Follow the Getting Started guide to scaffold your solution and wire up RESTworld services.
- Configure runtime behavior with Configuration, and review Pipeline Overview to choose the right pipeline.
- Secure your endpoints using Authorization and fine-tune DTO mappings with Mapping and Versioning.
Need a reference implementation? Explore src/Example/ExampleBlog.
Using an AI coding agent? Install the RESTworld plugin first, so it follows the framework conventions from the start.
Documentation map
- RESTworld documentation index
- Using RESTworld with AI agents
- How-To Cookbook
- Choosing a Pipeline
- Health and Operations
- Angular Client Development
- .NET Client Development
The documentation targets developers who build APIs and client applications on top of the RESTworld libraries. If you're looking for a higher-level pitch, read the refreshed README-short.
AI agent plugin
RESTworld ships a plugin with 17 skills for AI coding agents such as GitHub Copilot. The skills teach an agent how to build applications with RESTworld: adding an entity endpoint, DTOs, mappers, services, authorization, validation, API versions, tests, the .NET client and Angular pages. They are meant for developers who use the library, not for developers of the library itself.
Install it in Copilot CLI (the plugin has its own small repository, RESTworld-AI-plugin, so you do not have to clone the whole source tree):
copilot plugin marketplace add wertzui/RESTworld-AI-plugin
copilot plugin install restworld@restworld
Then ask your agent for a task, for example "add a Product endpoint". If the agent does not pick a skill, name it: "use the restworld-add-entity-endpoint skill".
- The skills live in
plugins/restworld/skills. You can also copy them into your own repository (for example.github/skills/) if your agent has no plugin support. - Copy
AGENTS.mdto the root of your solution so the agent knows the project layout and rules. - See Using RESTworld with AI agents for installation in VS Code (add
wertzui/RESTworld-AI-pluginto thechat.plugins.marketplacessetting), for a team-wide setup and for tips, and the How-To Cookbook for the full list of skills.
Contributing and feedback
- File issues or feature requests via GitHub Issues.
- Share ideas or improvements through pull requests—guided by the documentation above.
Enjoy building RESTful applications with RESTworld!
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. |
-
net10.0
- Asp.Versioning.OData.ApiExplorer (>= 10.2.1)
- AutoFixture (>= 4.18.1)
- AutoMapper.AspNetCore.OData.EFCore (>= 7.0.4)
- CsvHelper (>= 33.1.0)
- HAL.AspNetCore.OData (>= 22.0.1)
- HealthChecks.Kubernetes.Aspire (>= 2.0.5)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 10.0.12)
- Microsoft.AspNetCore.OpenApi (>= 10.0.12)
- Microsoft.Extensions.Http.Resilience (>= 10.10.0)
- Microsoft.Extensions.ServiceDiscovery (>= 10.10.0)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.18.0)
- OpenTelemetry.Extensions.Hosting (>= 1.18.0)
- OpenTelemetry.Instrumentation.AspNetCore (>= 1.18.0)
- OpenTelemetry.Instrumentation.EntityFrameworkCore (>= 1.17.0-beta.1)
- OpenTelemetry.Instrumentation.Http (>= 1.18.0)
- OpenTelemetry.Instrumentation.Runtime (>= 1.18.0)
- OpenTelemetry.Instrumentation.SqlClient (>= 1.18.0)
- RESTworld.Business (>= 27.0.0)
- Swashbuckle.AspNetCore (>= 10.2.3)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on RESTworld.AspNetCore:
| Package | Downloads |
|---|---|
|
RESTworld.Client.AspNetCore
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 39.0.0 | 71 | 10/31/2026 |
| 38.0.1 | 137 | 10/5/2026 |
| 38.0.0 | 231 | 9/15/2026 |
| 37.2.1 | 113 | 9/15/2026 |
| 37.2.0 | 249 | 9/10/2026 |
| 37.1.1 | 167 | 9/8/2026 |
| 37.1.0 | 175 | 8/23/2026 |
| 37.0.1 | 188 | 8/4/2026 |
| 37.0.0 | 139 | 7/28/2026 |
| 37.0.0-pre-2 | 103 | 7/24/2026 |
| 37.0.0-pre-1 | 109 | 4/13/2026 |
| 36.3.1 | 222 | 4/12/2026 |
| 36.3.0 | 122 | 4/4/2026 |
| 36.2.0 | 152 | 3/25/2026 |
| 36.1.0 | 139 | 3/12/2026 |
| 36.0.0 | 137 | 3/10/2026 |
| 35.2.0 | 306 | 2/10/2026 |
| 35.1.0 | 141 | 2/10/2026 |
| 35.0.0 | 148 | 2/9/2026 |
| 34.0.1 | 526 | 12/15/2025 |