Как создать собственные маршруты WebApi, такие как «package / {packageName} / {controller}», для маршрутизации к частям приложения в отдельной сборке?

Question

Наше приложение загружает контроллеры во внешние сборки, которые мы называем пакетами. Я хочу создать маршрут, который направляет пакет, используя URL-адреса, такие как package/BillingPackage/Invoice, а не api/BillingPackage/Invoice. Вот что я сделал:

Startup.cs

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseEndpointRouting()
        .UseMvc(routes =>
    {
        routes.MapRoute(
            name: "package", 
            template: "package/{package}/{controller}/{id?}");
        routes.MapRoute("api", "api/{controller}/{action=Get}/{id?}");            
        routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
    });
    app.UseStaticFiles();
}

public IServiceProvider ConfigureServices(IServiceCollection services)
{
    var source = new PackageAssemblySource(Configuration);
    var packageAssemblies = source.Load();
    var builder = new ContainerBuilder();
    builder.RegisterModule(new WebApiModule(packageAssemblies));

    services
        .AddMvc()
        .ConfigureApplicationPartManager(manager =>
        {
            // Add controllers and parts from package assemblies.
            foreach (var assembly in packageAssemblies)
            {
                manager.ApplicationParts.Add(new AssemblyPart(assembly));
            }
        });
        .AddControllersAsServices() // Now that AssemblyParts are loaded.
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);;

    builder.Populate(services);
    ApplicationContainer = builder.Build();

    return new AutofacServiceProvider(ApplicationContainer);
}

Тогда я определяю контроллер следующим образом:

[Route("package/BillingPackage/[controller]", Name = "Invoice")]
public class InvoiceController : ControllerBase
{
    [HttpGet()]
    public ActionResult<Invoice> Get()
    {
        return new SampleInvoice();
    }
}

Даже при всем этом package/BillingPackage/Invoice дает 404, тогда как api/BillingPackage/Invoice - нет. Как заставить мой WebApi обслуживать конечные точки с package, а не с api?

Answer 1

Возможно, вы столкнулись с конфликтом маршрутов с шаблоном: "package/{package}/{controller}/{id?}".

Если на контроллере используется атрибутная маршрутизация, удалите этот условный маршрут

Чтобы получить желаемое поведение, вам необходимо включить параметр шаблона [Route("package/{package}/[controller]", Name = "Invoice")] вместе с аргументом метода / действия public ActionResult<Invoice> Get(string package), который будет заполнен из сопоставленного значения из URL.

Например

[Route("package/{package}/[controller]", Name = "Invoice")]
public class InvoiceController : ControllerBase {

    //GET package/BillingPackage/Invoice
    [HttpGet()]
    public ActionResult<Invoice> Get(string package) {
        return new SampleInvoice();
    }
}

Ссылка Маршрутизация к действиям контроллера в ASP.NET Core