SDammann.WebApi.Versioning 技术文档

1. 安装指南

首先，确保您的开发环境已安装了.NET框架。然后，您可以通过Nuget包管理器安装SDammann.WebApi.Versioning。在Visual Studio中，打开Nuget包管理器控制台，执行以下命令：

Install-Package SDammann.WebApi.Versioning

2. 项目的使用说明

设置

在依赖注入容器中注册DefaultControllerIdentificationDetector和DefaultRequestControllerIdentificationDetector类。

接下来，选择一个版本控制方案，并在库中注册。例如，要使用基于API路由的版本控制（这将使用类似/api/v1.2/product/的URL），请在Web API配置委托中包含以下内容：

ApiVersioning.Configure(config)
             .ConfigureRequestVersionDetector<DefaultRouteKeyVersionDetector>();

确保config变量为HttpConfiguration类型，并在依赖注入容器中注册此类。

选择API版本控制方案

目前，库支持两种API版本控制方案。

基于URL / 路由的API版本

这允许通过URL路由方案选择API版本。例如：

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

然后在Web API配置委托中注册版本检测器：

ApiVersioning.Configure(config)
             .ConfigureRequestVersionDetector<DefaultRouteKeyVersionDetector>();

基于HTTP头的API版本

这是许多REST纯粹主义者偏好的方案。它允许通过请求的Accept头中的MIME类型选择API版本。为了实现这一点，请继承AcceptHeaderRequestVersionDetector并实现GetVersionFromSingleHeader方法。

然后，在Web API配置委托中注册您的实现：

ApiVersioning.Configure(config)
             .ConfigureRequestVersionDetector<YourCustomRoutingDetector>();

不要忘记在内容协商中设置自定义MIME类型，以便ASP.NET Web API输出正确的响应格式。

3. 项目API使用文档

SDammann.WebApi.Versioning提供了多种接口和类，以支持API版本控制。以下是一些主要接口和类的简要说明：

• IControllerNameDetector：用于检测控制器名称。
• IControllerVersionDetector：用于检测控制器版本。
• IRequestControllerNameDetector：用于从请求中检测控制器名称。
• IRequestVersionDetector：用于从请求中检测版本。
• ApiVersion：表示API版本的抽象类。

您可以根据需要扩展或实现这些接口，以满足自定义版本控制需求。

4. 项目安装方式

如前所述，您可以通过Nuget包管理器安装SDammann.WebApi.Versioning。在Visual Studio中，打开Nuget包管理器控制台，执行以下命令：

Install-Package SDammann.WebApi.Versioning

这将自动将所需的引用添加到您的项目中，以便您可以使用SDammann.WebApi.Versioning提供的功能。