标签: api-versioning

希望有人尝试过与MVC 6和Swagger中的版本化API类似的东西,以显示有关不同版本的文档.

我在这个ASP.NET 5存储库中使用MVC 6中推荐的API版本.我所做的唯一改变是GetVersion方法从请求的自定义http头读取api版本:

//in VersionRangeValidator.cs
public static string GetVersion(HttpRequest request)
{
        //return request.Query["version"];
        if (!string.IsNullOrWhiteSpace(request.Headers[Constants.CommonRoutingDefinitions.ApiVersionSegmentName]))
        {
            return request.Headers[Constants.CommonRoutingDefinitions.ApiVersionSegmentName];
        }
        return Constants.CommonRoutingDefinitions.CurrentApiVersion;
 }

我有一个像这样的控制器:

[Route("api/[controller]")]
[Produces(Constants.MediaTypeNames.ApplicationJson)]
public class TagsController : Controller
{
    private readonly ITagService _tagService;

    public TagsController(ITagService tagService)
    {
        _tagService = tagService;
    }

    /// <summary>
    /// Version 1 by default
    /// </summary>
    /// <returns>All the tags</returns>
    [HttpGet]
    [Produces(typeof(IEnumerable<Tag>))]
    public IEnumerable<Tag> GetTags()
    {
        IEnumerable<Tag> tags = _tagService.GetTags();
        return tags;
    }

    /// <summary>
    /// Version 2
    /// </summary> …

我是api版本控制的新手，所以我的问题是：

1）此文件夹结构是否正确？

/app
  /controllers
    /Api
      /v1
        /UserController.php
      /v2
        /UserController.php

路线：

Route::group(['prefix' => 'v1'], function () {
  Route::get('user',      'Api\v1\UserController@index');
  Route::get('user/{id}', 'Api\v1\UserController@show');
});

Route::group(['prefix' => 'v2'], function () {
  Route::get('user',      'Api\v2\UserController@index');
  Route::get('user/{id}', 'Api\v2\UserController@show');
});

2）关于模型和事件的文件夹结构如何，我应该为每个版本制作模型吗？

我有一个 ASP.NET Core 3.1 API，我正在为我的一个控制器引入新版本。我正在使用Microsoft.AspNetCore.Mvc.Versioning NuGet 包，并且已将新版本设置为默认版本。我的所有其他控制器都应适用于旧版本（1.0）和新版本（1.1）。

例如：

    [ApiVersion("1.0", Deprecated = true)]
    public class MySampleController
    {
    }
    
    [ApiVersion("1.1")]
    public class MyNewSampleController
    {
    }

    [ApiVersion("1.0", Deprecated = true)]
    [ApiVersion("1.1")]
    public class AllOtherController
    {
    }

问题：
我真的必须将所有版本添加到所有控制器吗？
有更好/正确的方法来处理这个问题吗？

我尝试使用 [ApiVersionNeutral] 但这似乎不正确，根据文档，应该只在特殊情况下使用。如果我不添加 [ApiVersion] 属性，则默认为新的 1.1 版本，1.0 不再有效。

由于这是我的第一个问题，我希望它符合指导方针:)

我之前为我的观点创建了一些测试。像那样

class TestUserRegistrationViewUserCreate(APITestCase):
def setUp(self):
    self.factory = APIRequestFactory()

def test_create_user(self):
    data = {
        'phone_number': '+79513332211',
        'password': 'qwerty'
    }
    request = self.factory.post(reverse('user'), data=data)
    response = CustomUserAPIView.as_view()(request)
    self.assertEqual(response.status_code, status.HTTP_201_CREATED)

一切都很好，直到我被要求添加 API 版本控制。

DRF 支持本地版本控制http://www.django-rest-framework.org/api-guide/versioning/ 所以我只是使用它并将基于命名空间的版本控制添加到我的 API 中

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.NamespaceVersioning'
}

现在我需要重写我的视图单元测试以支持版本控制。

这个问题是，为了通过 获得版本化的 url reverse，我必须使用

from rest_framework.reverse import reverse

reverse('bookings-list', request=request)

就像在文档中一样。

但是我request在测试中没有对象，因为我正在自己制作一个对象，并且需要制作它的版本化 url。

我该怎么办？

PS 我可以在不使用 DRF 的情况下实现版本控制，使用视图装饰器和几个 utils 函数来解决这个问题，但是当我重新发明轮子时，这对我来说感觉很糟糕。另外，我也可能会忘记一些边缘情况。

我正在为 Webapi 服务中的所有错误创建一个包库。该库将用于为 BadRequest、BadArgument、ApiVersionsing 等相关错误提供自定义响应。我需要帮助自定义 Apiversion 相关错误 - ApiVersionUnspecified、UnsupportedApiVersion、InvalidApiVersion、AmbiguousApiVersion。我已经按照这篇文章为我的项目包含 api-versioning - https://www.hanselman.com/blog/ASPNETCoreRESTfulWebAPIVersioningMadeEasy.aspx

我已经检查了上述包的 github wiki，发现“根据所需的行为，您可以扩展 DefaultErrorResponseProvider 或者您可以从 stratch 实现您自己的 IErrorResponseProvider。

要连接备用错误响应行为，请将默认提供程序替换为您自己的：”

options => options.ErrorResponses = new MyErrorResponseProvider();

然而; 我不太明白如何自定义 MyErrorResponseProvider 类中的默认错误响应。有人可以为我提供任何示例，以便我可以开始使用吗？

提前致谢！

我想准备我的.NET Core Web API项目，以便可以根据REST服务标准来管理和记录API的多个版本。

我正在使用带有NSwag（v11.18.2）的.NET Core 2.1。我还安装了Microsoft.AspNetCore.Mvc.Versioning NuGet程序包。

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    services.AddApiVersioning(options =>
        {
            options.AssumeDefaultVersionWhenUnspecified = true;
            options.DefaultApiVersion = new ApiVersion(1, 0);
            options.ReportApiVersions = true;
        });
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSwaggerWithApiExplorer(config =>
    {
        config.GeneratorSettings.OperationProcessors.TryGet<ApiVersionProcessor>().IncludedVersions = new[] { "1.0" };
        config.SwaggerRoute = "v1.0.json";
    });

    app.UseSwaggerWithApiExplorer(config =>
    {
        config.GeneratorSettings.OperationProcessors.TryGet<ApiVersionProcessor>().IncludedVersions = new[] { "2.0" …