如何在asp.net core 3中添加全局路由前缀?

时间:2019-10-11 12:08:47

标签: asp.net-core routes

旧版.net核心框架使用UseMvc()添加全局路由前缀。如何在没有asp.net core 3的情况下为UseMvc()做它?

3 个答案:

答案 0 :(得分:4)

您可以参考asp.net core 3.0中的以下演示以使用api版本设置全局路由前缀。您可以通过更改services.AddControllersWithViews(o => { o.UseGeneralRoutePrefix("api/v{version:apiVersion}"); });

来设置任何前缀。

1。创建自定义MvcOptionsExtensions

public static class MvcOptionsExtensions
{
    public static void UseGeneralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute)
    {
        opts.Conventions.Add(new RoutePrefixConvention(routeAttribute));
    }

    public static void UseGeneralRoutePrefix(this MvcOptions opts, string prefix)
    {
        opts.UseGeneralRoutePrefix(new RouteAttribute(prefix));
    }
}

public class RoutePrefixConvention : IApplicationModelConvention
{
    private readonly AttributeRouteModel _routePrefix;

    public RoutePrefixConvention(IRouteTemplateProvider route)
    {
        _routePrefix = new AttributeRouteModel(route);
    }

    public void Apply(ApplicationModel application)
    {
        foreach (var selector in application.Controllers.SelectMany(c => c.Selectors))
        {
            if (selector.AttributeRouteModel != null)
            {
                selector.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_routePrefix, selector.AttributeRouteModel);
            }
            else
            {
                selector.AttributeRouteModel = _routePrefix;
            }   
        }
    }
}

2。在Startup.cs中注册(您需要安装软件包Microsoft.AspNetCore.Mvc.Versioning,当前的3.0版本是4.0.0-preview8.19405.7)

public void ConfigureServices(IServiceCollection services)
    {
        //MVC service registration
        //https://docs.microsoft.com/en-us/aspnet/core/migration/22-to-30?view=aspnetcore-3.0&tabs=visual-studio#mvc-service-registration
        services.AddControllersWithViews(o => { o.UseGeneralRoutePrefix("api/v{version:apiVersion}"); });
        services.AddApiVersioning(o => o.ReportApiVersions = true);
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseAuthentication();
        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
            endpoints.MapRazorPages();
        });
    }

3.Controller:

[ApiVersion("1")]
[ApiVersion("2")]
[Route("test")]
[ApiController]
public class TestController : ControllerBase
{
    [HttpGet("version"), MapToApiVersion("1")]
    public IActionResult GetV1()
    {
        return new OkObjectResult("Version One");
    }
}

4。结果

呼叫/api/v1/test/version会产生“版本1”。

答案 1 :(得分:4)

我在 3.1 中解决了这个问题,仅在我的启动 Configure() 中使用了以下内容:

app.UsePathBase(new PathString("/api"));

答案 2 :(得分:0)

正如@alastairtree 回答的那样,您可以使用 app.UsePathBase 来实现这一点。

您需要在注册需要前缀的中间件之前进行此调用。

如果之后需要注册其他中间件,不需要前缀,可以将前缀重置为/

完整示例:

app.UsePathBase(new PathString("/api"));
app.UseRouting();
app.UseEndpoints(endpoints =>
{
    endpoints.MapControllerRoute(
        name: "default",
        pattern: "{controller}/{action=Index}/{id?}");
});

app.UsePathBase(new PathString("/"));
app.UseSpa(spa =>
{
    spa.Options.SourcePath = "ClientApp";

    if (env.IsDevelopment())
    {
        spa.UseAngularCliServer(npmScript: "start");
    }
});