4

我在我的Web API 帮助页面中收到重复的条目，其中包含不同的父项，例如这些引用相同的方法：

GET api/{apiVersion}/v1/Products - 获取所有产品

...

GET api/v1/Products - 获取所有产品

...

我有一个带有如下路由的 Web API 页面：

       config.Routes.MapHttpRoute (
            name: "DefaultVersionApi",
            routeTemplate: "api/{apiVersion}/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        config.Routes.MapHttpRoute (
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

我曾认为此路由将使“v1”成为可选，因此不需要上面的派生文档。

（侧边栏：去api/products肯定行不通，所以我不确定这有什么问题。我错过了什么？）

似乎真正的问题是 Web API 帮助页面不正确地读取了路由，正如我所想的那样v1，{apiVersion} 它们不应该出现在同一个动作中。 我在这里想念什么？

4

2 回答 2

6

尝试使用属性路由，安装 nuget 包

Install-Package Microsoft.AspNet.WebApi.WebHost

在 WebApiConfig.cs 中启用属性路由

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Attribute routing.
        config.MapHttpAttributeRoutes();

        // Convention-based routing.
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

然后在控制器的方法中使用属性 Route

[Route("~/api/v1/Products")]
[HttpGet]
public List<Product> Products()
{}

[Route("~/api/v2/Products")]
[HttpGet]
public List<Product> V2Products()
{}

在您将获得的文档中

GET api/v1/Products - 获取所有产品

GET api/v2/Products - 获取所有产品

于 2015-03-12T11:30:28.940 回答
2

这似乎是 ASP.NET Web API 帮助页面的一个缺点。为了解决这个问题，我更改了视图以从呈现的文档中排除这些无效路由。对于上面的例子，我在ApiGroup.cshtml的循环中添加了这个 Where 子句，改变了

@foreach (var api in Model){

到

@foreach (var api in Model.Where(m => !m.Route.RouteTemplate.Contains(@"{apiVersion}"))){
于 2015-03-30T18:09:50.490 回答