Koan.Web
0.5.2
dotnet add package Koan.Web --version 0.5.2
NuGet\Install-Package Koan.Web -Version 0.5.2
<PackageReference Include="Koan.Web" Version="0.5.2" />
<PackageVersion Include="Koan.Web" Version="0.5.2" />
<PackageReference Include="Koan.Web" />
paket add Koan.Web --version 0.5.2
#r "nuget: Koan.Web, 0.5.2"
#:package Koan.Web@0.5.2
#addin nuget:?package=Koan.Web&version=0.5.2
#tool nuget:?package=Koan.Web&version=0.5.2
Sylin.Koan.Web
ASP.NET Core integration for Koan: controller-first routing, health endpoints, well-known endpoints, and observability bootstrap.
- Target framework: net9.0
- License: Apache-2.0
Capabilities
- MVC controller-first routing (attribute-routed)
- Health endpoints and OpenAPI wiring (opt-in)
- Transformers for payload shaping (see WEB-0035)
Install (minimal setup)
dotnet add package Sylin.Koan.Web
Usage — quick examples
- Expose REST endpoints via controllers, not inline endpoints:
public sealed class ItemsController : EntityController<Item, Guid>
{
// GET /api/items
[HttpGet("api/items")]
public async Task<IActionResult> GetAll(CancellationToken ct)
=> Ok(await Item.FirstPage(50, ct));
}
- Use transformers for response shaping; see decision WEB-0035.
See TECHNICAL.md for contracts, options, and integration details.
Customization
- Configuration and advanced usage are documented in
TECHNICAL.md
.
References
- Web API conventions:
/docs/api/web-http-api.md
- Decision:
/docs/decisions/WEB-0035-entitycontroller-transformers.md
- Engineering guardrails:
/docs/engineering/index.md
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net9.0 is compatible. 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. |
-
net9.0
- Koan.Core (>= 0.5.2)
- Koan.Data.Abstractions (>= 0.5.2)
- Koan.Data.Core (>= 0.5.2)
- Koan.Scheduling (>= 0.5.2)
- Microsoft.AspNetCore.Mvc.NewtonsoftJson (>= 9.0.0)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
- OpenTelemetry.Instrumentation.AspNetCore (>= 1.8.1)
- OpenTelemetry.Instrumentation.Http (>= 1.8.1)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on Koan.Web:
Package | Downloads |
---|---|
Koan.Media.Core
Media core for Koan: Ensure, pipelines, ancestry, and URL helpers over Koan.Storage. |
|
Koan.Web.Extensions
Web capability extensions (moderation, soft-delete, audit) for Koan applications. |
|
Koan.Web.Transformers
HTTP payload transformers for Koan Web: flexible request/response shaping with auto-discovery. |
|
Koan.Recipe.Observability
Observability baseline recipe (health checks + OTEL + resilient HttpClient). |
|
Koan.Web.GraphQl
Koan GraphQL module providing a controller-hosted GraphQL endpoint and schema for IEntity<> types. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
0.5.2 | 195 | 9/16/2025 |
See release notes: https://github.com/sylin-labs/Koan-framework/releases