RoutesList 1.0.2

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

// Install RoutesList as a Cake Tool
#tool nuget:?package=RoutesList&version=1.0.2

RoutesList

Library can be used to show a list of all the registered routes for the application.

Library show all Routes in table format - methods, Uri, Controller Name, Action, Full name of path or namespace

Compatible with:

  • NET6
  • Razors Pages
  • ASP.NET projects with MVC
  • Blazor Server App

Features

  • Endpoints with method, uri, controller name, action, full namespace path
  • Endpoints for Razor pages with name, Relative Path, view engine path
  • HTML5 output
  • JSON output
  • Custom class for table
  • link to endpoints in table view

Table list image

Table json list image

Installation

From nuget.org

Install-Package RoutesList 

Usage

Just add services.AddRoutesList to service ConfigureService method.

<b>Example:</b> Startup.cs

\\...
public void ConfigureServices(IServiceCollection services)
{
    \\...
    services.AddRoutesList();
}

and add to Configure method

<b>Example:</b> Startup.cs

\\...
public void Configure(
    IApplicationBuilder app,
    IWebHostEnvironment env,
)
{
    \\...
    app.UseRoutesList();
}

Default Endpoint: http://your_application_address/routes

<hr>

Usage for implicit Using Statements In .NET 6

<b>Example</b>: Program.cs

using RoutesList.Gen;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();

builder.Services.AddRoutesList(); <-- usage

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment()) {
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.UseRoutesList(); <-- usage

app.Run();

public partial class Program { }

<hr>

options for UseRoutesList

In app.UseRoutesList you can pass options

Name Description
Endpoint endpoint name
Title Title for web site
SetTableClasses Add template classes for table

<b>Example:</b> Startup.cs

public void Configure(
    IApplicationBuilder app,
    IWebHostEnvironment env,
)
{
    IDictionary<string, string[]> dict = new Dictionary<string, string[]>();
    string[] classes = dict["table"] = new string[2] { "table", "table-striped" };

    app.UseRoutesList(options => {
        options.Endpoint = "your_new_endpoints";
        options.Tittle = "Your new Title for site";
        options.SetTableClasses(classes);
    });
}

<hr>

Contributing

Contributions are always welcome, whether adding/suggesting new features, bug fixes, documenting new file formats or simply editing some grammar. for this create new github issue and descript your problem and add issue tag for Bug/enhancement

Product 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 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. 
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
1.1.2 51 4/30/2024
1.1.1 1,138 8/13/2023
1.1.0 718 5/2/2023
1.0.2 1,045 12/17/2022
1.0.1 803 11/11/2022
1.0.0 726 11/11/2022
0.2.2 1,752 3/27/2022
0.2.1 2,094 12/29/2021
0.2.0 600 12/25/2021
0.1.0 1,288 6/20/2020