Phema.Routing 3.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Phema.Routing --version 3.0.0
NuGet\Install-Package Phema.Routing -Version 3.0.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="Phema.Routing" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Phema.Routing --version 3.0.0
#r "nuget: Phema.Routing, 3.0.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.
// Install Phema.Routing as a Cake Addin
#addin nuget:?package=Phema.Routing&version=3.0.0

// Install Phema.Routing as a Cake Tool
#tool nuget:?package=Phema.Routing&version=3.0.0

Phema.Routing

Build Status Nuget

C# strongly typed routing library for ASP.NET Core built on top of MVC Model conventions with built-in From.*, ApiExplorer, Authorization and Caching support

Usage

// Startup
services.AddMvcCore()
  .AddRouting(routing => {});
  • You have two ways to add routing: using IMvcBuilder or IMvcCoreBuilder extensions - AddRouting
  • In AddRouting pass callback with IRoutingConfiguration to register route parts

Adding controller

// Startup
services.AddMvcCore()
  .AddRouting(routing =>
    // Add controller
    routing.AddController<TestController>("controller-route-part", controller => {});
  • To add controller you need to specify TController and route part
  • You can remove route part: AddController<TestController>(controller => {}).
  • It will be an empty string (so just / route)

Adding routes

// Startup
services.AddMvcCore()
  .AddRouting(routing =>
    routing.AddController<TestController>("controller-route-part",
      // Add route
      controller => controller.AddRoute("action-route-part", c => c.TestMethod()));
  • To add action route you need to specify an action route (goes after controller route controller/action) and expression for method
  • By default route adds without any http method constraint (so you can call it with get, post, etc.)

Adding constraints

// Startup
services.AddMvcCore()
  .AddRouting(routing =>
    routing.AddController<TestController>("controller-route-part",
      controller =>
        controller.AddRoute("action-route-part", c => c.TestMethod())
          // Add constraints
          .HttpGet()
          .Authorize());
  • You can add constraints to both: controller and route using IRouteBuilder returned by AddController or AddRoute
  • You can add them by using AddFilter/AddConstraint method with IServiceProvider parameter or extension without it
  • You can add named routes by using WithNamed method
  • To use predefined constraints and filters you need a Phema.Routing.Extensions package
  • For caching you can use Phema.Routing.Extensions.Caching package
  • To create custom filters and constraints you need IFilterMetadata or IActionConstraintMetadata in Microsoft.AspNetCore.Mvc.Abstractions package or inherit from derivatives
  • You can add HttpGet, Cached, etc. to controller's IRouteBuilder it means that any action inside will be HttpGet, Cached, etc.

Adding parameters

services.AddMvcCore()
  .AddRouting(routing =>
    routing.AddController<TestController>("controller-route-part",
      controller =>
        controller.AddRoute("action-route-part",
            // Add parameter source
            c => c.TestMethod(From.Query<string>()))
          .HttpGet());
  • You can specify from wich source mvc will bind your model
  • To specify parameters you have to use From static class
  • To inject arguments from DI use From.Services method
  • From.* is matches [From*] attributes, so no more attributed parameters polluting your controller actions
  • To use From.Body don't forget to add mvc formatters using AddMvcCore

Features

  • Flexible constraint and filter configuration
  • Extension methods for authorization, caching, api documentation
  • Selection BindingSources and named parameters (constant names only)
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. 
.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
3.0.5 1,119 9/25/2019
3.0.4 995 8/27/2019
3.0.3 1,176 7/27/2019
3.0.2 1,122 7/26/2019
3.0.1 1,123 7/25/2019
3.0.0 983 7/19/2019