首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >禁用某些API版本的控制器

禁用某些API版本的控制器
EN

Stack Overflow用户
提问于 2022-08-03 14:34:12
回答 1查看 102关注 0票数 0

我们正在我们的应用程序中开发一个新的API版本,所以我们基本上有一个

代码语言:javascript
复制
namespace Bla.V1.Controllers
[ApiController]        
[ApiVersion("1")]
public partial class SampleController : ControllerBase {}

和一个

代码语言:javascript
复制
namespace Bla.V2.Controllers
[ApiController]        
[ApiVersion("2")]
public partial class SampleController : ControllerBase {}

我们还配置了API版本控制(AddApiVersioning),以便当有人试图访问api/v3/sample/action时,他将得到一个由API版本控制中间件提供的不受支持的错误响应版本。

现在,V2版本正在开发中,我们希望只在开发阶段提供它。控制器代码将被部署到生产中,但是我们希望禁用生产中的V2版本。

我们会使用一个特性标志来完成这个任务,但是应该做些什么来隐藏V2控制器呢?我在想:

  • 不知何故不注册V2控制器。在API版本控制中间件中,在AddControllers()
  • Set最大版本中找不到适合V1的选项。这只适用于报头,不阻止对V2控制器

的访问

我目前正在考虑编写一个授权属性,该属性将根据功能标志状态拒绝访问,并将其应用于V2控制器。有没有更好、更优雅的方法来做到这一点?

EN

回答 1

Stack Overflow用户

发布于 2022-08-04 08:05:57

万一有人对此感兴趣。我们的控制器代码是从Swagger定义自动生成的。因此,我将以下代码添加到生成模板中,在每个控制器方法中调用该模板:

代码语言:javascript
复制
if (!this.IsV2Enabled())
            {
                var protocol = this.Request.IsHttps ? "https" : "http";
                return this.BadRequest(new
                {
                    error = new {
                        code = "UnsupportedApiVersion",
                        message = $"The HTTP resource that matches the request URI '{protocol}://{this.Request.Host}{this.Request.Path}' does not support the API version '1'."
                    }
                });
            }
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/73223346

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档