在 JavaScript 中维护 WebAPI 端点

Question

我想知道是否有任何好的技术可以让您的 WebAPI 控制器路由与客户端保持同步。

例如，您有一个 WebAPI 控制器 BooksController。在客户端，您可以通过调用端点来调用方法：

$.get('books/1');

然后有一天你决定重命名控制器，或者添加一个 RoutePrefix。这会破坏客户端代码，因为端点已更改。

我遇到了图书馆WebApiProxy，看起来很有趣。有没有人有解决这个问题的好方法？是否有理由在我可能忽略的客户端上使用字符串文字？

Answer 1

我创建了一个关于该主题的博文。看看:)

http://blog.walden.dk/post/2017/02/02/export-all-your-asp-net-webapi-endpoints-to-json

我正在写一篇在 javascript 中使用它的帖子。无论如何，此代码会导出端点运行时，并将用于重构和路由更改。它还导出 uri 参数，它们可用于在 javascript 中解析并替换为来自客户端的值。

实现你想要的最简单的方法是使用 ASP.NET WEBAPI 中内置的 ApiExplorer。它搜索所有“ApiController”实现，并读取路由属性元数据。

public class EndpointManager
{
    public IEnumerable<ApiMethodModel> Export()
    {
        //Use the build-in apiexplorer to find webapi endpoints
        IApiExplorer apiExplorer = GlobalConfiguration.Configuration.Services.GetApiExplorer();
        //exclude endpoints without the attribute
        var apiMethods = apiExplorer.ApiDescriptions.Select(ad => new ApiMethodModel(ad)).ToList();
        return apiMethods;
    }
}

您可以创建一个端点来返回生成的数据。

[RoutePrefix("api/endpoint")]
public class EndpointApiController : ApiController {
 [HttpGet]
    [Route("all")]
    public IEnumerable<ApiMethodModel> All()
    {
        var endpoints = new EndpointManager().Export();
        return endpoints;
    }
}

现在可以在“/api/endpoint/all”到达所有端点

Answer 2

这是我在对您的问题的评论中谈到的一个示例：

function getUrl(uri) {
  var bookRoute = /books(.*?)/i;
  var otherRoute = /something(.*?)/i;
  
  if(uri.match(bookRoute)) {
    return uri.replace(bookRoute, "http://localhost/webapi/books$1")
  }
  
  if(uri.match(otherRoute)) {
    return uri.replace(otherRoute, "http://mydomain/api/something$1")
  }
  
  return uri;
}

alert(getUrl("books/1"));
alert(getUrl("something/realy/different/1"));

您只需要在函数体中定义路由即可。