asp.net-web-api - 为 ASP.NET Web API 应用程序生成特定于版本的帮助文档页面

Question

我正在使用 WebAPI Versioning package使用“VersionHeaderVersionedControllerSelector”通过 X-Api-Header 对我的 API 进行版本控制。我也在使用Microsoft.AspNet.WebApi.HelpPage自动生成 API 文档。为了使 Controller 版本识别工作，它们需要使用 VersionXYZ 作为命名空间中的后缀进行命名，以便“VersionHeaderVersionedControllerSelector”能够将请求路由到适当版本的 Controller ，如下所示:

namespace WEBAPI.Api.Controllers.Version1
{ public class ProductsController : ApiController {} }

namespace WEBAPI.Api.Controllers.Version2
{ public class ProductsController : ApiController {} }

这按预期工作，但是当我查看生成的帮助页面时 ApiDescription在ID (GETapi/Version1.Products) 和RelativePath(api/Version1.Products) 属性中包含命名空间中的“VersionXYZ”后缀。理想情况下，我想做的是拥有一个顶级帮助页面，其中只有 API 版本号和钻取会以正常方式显示 API，即 ApiDescription.ID = GETapi/Products 和 ApiDescription.RelativePath = api/Products

有没有办法使用开箱即用的 API 来实现此目的，或者我是否需要推出我自己的 ApiExplorer 实现

Answer 1

看看这个答案 Get Help page works with Api Versioning

确保您已正确配置版本控制，并且需要从您的项目 XXXX.Api.v1 项目中获取文档 XML 文件，并将其放置在 XXXX.Api 项目的 bin 文件夹中。