aspnetcore/src/Microsoft.AspNetCore.Mvc.Core/Routing/IRouteTemplateProvider.cs

30 lines
1.2 KiB
C#

// 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.
namespace Microsoft.AspNetCore.Mvc.Routing
{
/// <summary>
/// Interface for attributes which can supply a route template for attribute routing.
/// </summary>
public interface IRouteTemplateProvider
{
/// <summary>
/// The route template. May be null.
/// </summary>
string Template { get; }
/// <summary>
/// Gets the route order. The order determines the order of route execution. Routes with a lower
/// order value are tried first. When a route doesn't specify a value, it gets a default value of 0.
/// A null value for the Order property means that the user didn't specify an explicit order for the
/// route.
/// </summary>
int? Order { get; }
/// <summary>
/// Gets the route name. The route name can be used to generate a link using a specific route, instead
/// of relying on selection of a route based on the given set of route values.
/// </summary>
string Name { get; }
}
}