我们有几个ApiController实现，我们不希望大多数操作包含在ApiExplorer的元数据中。默认情况下，如果您不将[ApiExplorerSettings(IgnoreApi = true)]添加到您的操作中，它将被添加，因此这意味着默认值为false。这可能是因为IgnoreApi是一个布尔值，并且默认为false，但是如何才能将此默认值更改为true，而不必覆盖ApiExplorerSettings 这是一个基本
浏览 90提问于2019-04-24得票数 1
回答已采纳
您可以使用设置IgnoreApi属性来装饰控制器或操作方法，以不生成帮助信息。如果尝试对操作方法的属性应用相同的属性，则会得到一个错误：
public HttpResponseMessage Post([ApiExplorerSettings(IgnoreApi = true)]保持控制器操作可测试性的一个常见约定是接受HttpRequestMessage参数，但这是一个实现细节，而不是您的API使用者应该知道的事情。如何防止ApiExplor
浏览 2提问于2013-05-20得票数 3
回答已采纳
1回答
我目前正在使用Web 2的属性路由()实现Web。我还使用帮助页面模块，以便从XML ()自动生成文档。对于这个API，我提供了对可选返回格式扩展的支持，这样每个API方法都有一对在其上定义的路由，如下所示：[Route("Path/Foo")]public HttpResponseMessage DoFoo() // Some API function.这允许用户点击
浏览 2提问于2013-10-25得票数 4
回答已采纳
1回答
我刚开始装腔作势，让它安装并运行，但它接收的API文件远远超出了我的期望。我一直在寻找一种方法来指定哪个API是文档化的。
浏览 3提问于2020-03-13得票数 4
回答已采纳
2回答
我是一个新的蜜蜂，使用微服务( Spring，Spring)，在其中我尝试在另一个微服务中使用微服务的资源文件。为此，我需要通过ComponentScan在另一个模块中扫描该模块。basePackages = {"com.example.admin"，“com.example.main”)}
我在AdminApplication file.Now中使用了这个，它还在Admin中显示了主模块的控制器，这是我不想要的。如何才能真正排除这一点？请帮帮我。
浏览 0提问于2018-09-07得票数 1
我们为我们的API提供了一个API文档，我们想要做的是从文档中排除某些web方法，但我们希望根据我们运行的环境动态完成这一点。为了让你理解我的意思，假设我有下面的web方法public Product getProduct() ...}
通过将ApiExplorerSettingAttribute上的IgnoreAPI属性设置为true，它从文档中排除了web方法，这正是我们想
浏览 0提问于2015-01-15得票数 10
回答已采纳
请注意，隐藏控制器/方法在所有场景中都是可用的，但不会在SwaggerUI中记录。using Swashbuckle.AspNetCore.SwaggerGen;using Microsoft.AspNetCore.Mvc.ApiExplorer//controllerSwaggerUIVisibilityAttribute.IgnoreApi = true;
浏览 6提问于2021-06-11得票数 3
回答已采纳
我目前在我的项目中使用swagger，我在那里有100多个控制器。我猜由于大量的控制器，swagger UI文档页面需要超过5分钟来加载它的控制器。是否可以在UI页面选择特定的控制器并仅为其加载选项？
浏览 1提问于2017-01-20得票数 20
我有一个控制器，我在类级别声明它不会出现在自动生成的API帮助页面中，如下所示：public classmethod2() {/*...*/} /*...*/现在，假设我只想覆盖method2的ApiExplorerSettings显然我试过了：
[Authoriz
浏览 1提问于2017-05-10得票数 1
默认的ApiExplorer和帮助页面非常有效，直到我向Api控制器引入版本为止。为了发现我的Api，我必须重写DefaultHttpControllerSelector，以考虑到任何客户端提供的命名空间，并将它们映射到右控制器：
Configuration.Services.GetApiExplorer().ApiDescriptions
我如何定制现有的ApiExplor
浏览 11提问于2014-02-10得票数 7
回答已采纳
我正在寻找一种方法，以一种可配置的方式使用SwashBuckle在Swagger文档中显示/隐藏WebAPI路由。添加[ApiExplorerSettings(IgnoreApi = true)]确实会隐藏路由，但每次我想要更改它时，都需要重新编译。我已经研究过创建一个IOperationFilter来使用我定义的自定义属性。该属性的定义如下：{
public string[] Tags { ge
浏览 1提问于2016-03-24得票数 9
回答已采纳
在我添加了 services.AddVersionedApiExplorer(); 以前正常工作的Swashbuckle开始显示空白的Swagger json，默认版本，其中没有端点。
浏览 36提问于2021-10-28得票数 1
我希望能够从文档中省略某些方法，但我似乎不知道如何告诉Swagger不要将它们包含在Swagger输出中。我感觉到这与添加模型或模式筛选器有关，但不清楚该做什么，文档似乎只提供了如何为方法修改输出的示例，而不是从输出中完全删除它。
浏览 0提问于2015-04-17得票数 242
我想知道是否有什么好的技术可以使您的WebAPI控制器路由与客户端保持同步。我偶然发现了库，它看起来很有趣。有没有人有解决这个问题的好方法？有没有我可能忽略的在客户机上使用字符串的原因？
浏览 0提问于2016-03-21得票数 0
我有一个POST方法，由于应用于该方法的，它接受多个参数。(如果没有自定义绑定，POST方法只能接受1个参数。)问题是ApiExplorer无法确定这些参数的ApiParameterSource。如果只有一个参数，即使使用相同的参数绑定，也可以正常工作。，Source属性是由框架的ApiExplorer类决定的，而不是在帮助页面区域中。)(它破坏了我的自定义绑定，所以我取消了更改。)
我试图了解发生了什么，或者简单地理解Api
浏览 2提问于2016-02-24得票数 0
在我的net应用程序中，所有控制器都是从一个基本控制器继承的。我用visual studio创建了一个示例项目，swagger工作得很好。但是，当我创建一个从ControllerBase继承的基类(Test.cs)，并将ValuesController.cs更改为从测试继承而不是从ControllerBase继承时，swagger就无法工作获取未定义的错误/swagger/v1/swagger.json
谢谢你的帮助!这是我
浏览 0提问于2019-08-13得票数 1
我正在尝试在我的web服务的控制器中实现一个Options方法，该方法将返回一条消息，其中包含与控制器关联的URI端点的有效HTTP方法。resp.Content = new StringContent("");
foreach (ApiDescription api in apiExplorer</e
浏览 4提问于2012-08-17得票数 14
我需要在发布模式中排除我的应用程序接口帮助页面我试图在webapi配置文件中添加ApiExplorerSettingsAttribute().IgnoreApi = true，但是没有用，我们如何实现它
浏览 33提问于2017-06-28得票数 0
我的WebApi控制器位于程序集中(自托管的OWIN应用程序或ASP应用程序)。是否可以从另一个应用程序(动态加载带有WebApi控制器的程序集)中使用ApiExplorer来生成WebApi文档？
浏览 3提问于2015-09-09得票数 0
云服务器
ICP备案
对象存储
云点播
实时音视频
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号