Ottieni l'elenco di tutti i percorsi

Question

In ASP.NET Core, c'è un modo per visualizzare un elenco di tutti i percorsi definiti in Avvio? Stiamo utilizzando il metodo di estensione MapRoute di IRouteBuilder per definire i percorsi.

Stiamo migrando un progetto WebAPI di progetto precedente. Lì potremmo usare GlobalConfiguration.Configuration.Routes per ottenere tutti i percorsi.

In particolare, lo stiamo facendo all'interno di un filtro azione.

public class MyFilter : ActionFilterAttribute 
{  
    public override void OnActionExecuting(ActionExecutingContext actionContext) 
    { 
     base.OnActionExecuting(actionContext); 

     // This no longer works 
     // var allRoutes = GlobalConfiguration.Configuration.Routes; 

     // var allRoutes = ??? 
    } 
} 

Answer 1

È possibile ottenere una HttpRouteCollection dal HttpActionContext via:

actionContext.RequestContext.Configuration.Routes 

RequestContext

HttpConfiguration

HttpRouteCollection

- Dopo domanda aggiornato -

ActionExecutingContext ha una proprietà RouteData ereditata da ControllerContext, che espone la proprietà DataTokens (che è un dizionario del valore del percorso). Non è forse la stessa collezione si è abituati a lavorare con, ma fornisce l'accesso a quella raccolta:

actionContext.RouteData.DataTokens 

DataTokens

Answer 2

per arrivare a tutti i percorsi, è necessario utilizzare la parte ApiExplorer di MVC. È possibile contrassegnare tutte le azioni con un attributo o utilizzare una convenzione come questo:

public class ApiExplorerVisibilityEnabledConvention : IApplicationModelConvention 
{ 
    public void Apply(ApplicationModel application) 
    { 
     foreach (var controller in application.Controllers) 
     { 
      if (controller.ApiExplorer.IsVisible == null) 
      { 
       controller.ApiExplorer.IsVisible = true; 
       controller.ApiExplorer.GroupName = controller.ControllerName; 
      } 
     } 
    } 
} 

In Startup.cs, aggiungere il nuovo in ConfigureServices(...)

public void ConfigureServices(IServiceCollection services) 
{ 
    services.AddMvc(
     options => 
     { 
      options.Conventions.Add(new ApiExplorerVisibilityEnabledConvention()); 
      options. 
     } 
} 

nel costruttore ActionFilter è quindi possibile utilizzare iniezione per ottenere l'ApiExplorer:

public class MyFilter : ActionFilterAttribute 
{  
    private readonly IApiDescriptionGroupCollectionProvider descriptionProvider; 

    public MyFilter(IApiDescriptionGroupCollectionProvider descriptionProvider) 
    { 
     this.descriptionProvider = descriptionProvider; 
    } 

    public override void OnActionExecuting(ActionExecutingContext actionContext) 
    { 
     base.OnActionExecuting(actionContext); 

     // The convention groups all actions for a controller into a description group 
     var actionGroups = descriptionProvider.ApiDescriptionGroups.Items; 

     // All the actions in the controller are given by 
     var apiDescription = actionGroup.First().Items.First(); 

     // A route template for this action is 
     var routeTemplate = apiDescription.RelativePath 
    } 
} 

ApiDescription, che ha la RelativePath, che è il modello di percorso per quella route:

// Copyright (c) .NET Foundation. All rights reserved. 
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. 

using System; 
using System.Collections.Generic; 
using Microsoft.AspNetCore.Mvc.Abstractions; 
using Microsoft.AspNetCore.Mvc.ModelBinding; 

namespace Microsoft.AspNetCore.Mvc.ApiExplorer 
{ 
    public class ApiDescription 
    { 
     public string GroupName { get; set; } 
     public string HttpMethod { get; set; } 
     public IList<ApiParameterDescription> ParameterDescriptions { get; } = new List<ApiParameterDescription>(); 
     public IDictionary<object, object> Properties { get; } = new Dictionary<object, object>(); 
     public string RelativePath { get; set; } 
     public ModelMetadata ResponseModelMetadata { get; set; } 
     public Type ResponseType { get; set; } 
     public IList<ApiRequestFormat> SupportedRequestFormats { get; } = new List<ApiRequestFormat>(); 
     public IList<ApiResponseFormat> SupportedResponseFormats { get; } = new List<ApiResponseFormat>(); 
    } 
}