问题标签 [swashbuckle]

我正在使用 ASP.NET 和 Swagger，它们公开了一个接受 POST 的复杂类型。它有许多具有不同限制长度的字符串字段。如何在 Swagger UI 中反映这一点？

我有一个 ASP.NET WebAPI 项目，我试图用 Swagger UI 替换我们旧的 XmlDocumentationProvider 页面。我正在为 webAPI 5.3.1 nuget 包使用 swashbuckle swagger。

我能够导航到 localhost/MyApp/swagger，我可以在 fiddler 中看到它调用 localhost/MyApp/swagger/docs/v1 来检索代表我的 API 的 JSON 字符串。调用成功，JSON大约240KB，JSON有效。此时，chrome 选项卡会冻结大约 30 秒，然后会因“Aw snap”页面而崩溃。控制台中没有错误。

尝试在此在线验证器中验证 api JSON有效，并且仅当我取消选中所有三个“Follow ___ $refs”复选框时，规范/模式才有效。如果选中其中任何一个框，则大约需要 30 秒，然后该工具会崩溃。

不幸的是，我无法将整个 webAPI 规范粘贴到某个地方，但我会说它适用于非常庞大且非常复杂的内部业务应用程序。我们的一些 DTO 具有循环引用（与 DTO 本身类型相同的属性），我怀疑这可能会导致问题，但没有任何日志记录或调试我无法确定，并且有超过 1000 个 DTO 类我不想梳理它们以检查。

有没有办法为 swashbuckle（在服务器上）或 swagger UI（在客户端）打开任何类型的日志记录或调试？有没有人遇到过浏览器崩溃的问题并知道是什么原因造成的？提前谢谢。

我只是想从 swagger 文档中删除单词控制器。我看过使用 IOperationFilter 或 IDocumentFilter 来手动编辑标签，但属性是只读的。

我已经按照 GitHub 上的文档启用了 XmlComments。除了我无法更改控制器的描述之外，我没有任何其他问题。

在 Swaggerconfig 中：-

我在我的 Web API 项目中使用 Swashbuckle Swagger。默认情况下，所有控制器都列在同一页面上？

有什么方法可以让每个控制器都有单独的 URL，并且每个 URL 只会显示该控制器的操作？

我正在尝试在新的 asp .net CORE / MVC 6 项目中设置基本的 swagger API 文档，并从 swagger UI 收到 500 错误： 500 : http://localhost:4405/swagger/v1/swagger.json

我的启动类中有以下代码：

然后在配置下：

当我构建并运行项目时，当我转到 swagger/UI/index.html 时会出现 UI，但会显示上面的 500 错误。当我转到 swagger/v1/swagger.json 链接时，控制台给出以下 500 错误： Failed to load resource: the server responded with a status of 500 (Internal Server Error)

有什么办法可以找出 500 的根本原因，或者在 swagger 中启用任何额外的调试来找出它为什么会抛出这个错误？根据我看过的一些教程，基本实现只需要我在启动时拥有的东西。请让我知道我是否可以提供任何其他信息。

编辑：这是针对 rc1 的，可能与当前推出的新 netcore 1.0 无关（2016 年 6 月 29 日）

我在我的 Web API 中使用 Swashbuckle（C# 的招摇）。我有几个返回列表的 GET 端点，我允许用户将每页和页面参数添加到 QueryString

示例：http ://myapi.com/endpoint/?page=5&perpage=10

我看到 swagger 确实支持“查询”中的参数，但我如何让 Swashbuckle 做到这一点？

我在其中一条评论中提到，我通过创建自定义属性来解决我的问题，以允许我做我需要的事情。以下是我的解决方案的代码：

使用 Swagger Config 注册属性：

然后将此属性添加到您的方法中：

我想确保swagger/docs/v1但没有成功。

我在 web.configglobal.asax和<location>header 中尝试了一些重定向，但没有任何效果。

问题是这是通过 owin 中间件提供的，因此我无法Authorize在控制器或操作上使用该属性。

swagger/docs/v1什么是保护asp.net Web 应用程序中路径的好解决方案？

我有一个关于 ASP Web API 的项目。最近我已将 swashbuckle swagger 集成到项目中。但是每次我通过 swagger 尝试 api 调用时，我都会得到以下响应：

这是请求标头：

我的 startup.cs 如下所示：

如果我想通过默认查看 api 调用，一切都很好。任何身体都可以提供帮助。

先谢谢了。

我有一个包含大量服务的 Web API 项目。最初，我们使用 ASP.NET 开箱即用的标准 API 文档。

现在我想将我们的文档迁移到 Swagger。我使用Swashbuckle。我在文档中遇到了一些我不想描述的非常具体的问题。

话虽如此，也是因为我想保持我的 swagger 文档的清洁和高质量，我想找到一种方法来添加 API 以一个一个地招摇。

所以，主要问题是：我可以迁移到大摇大摆地逐步向文档中添加新的 API 并保持我的旧文档不变吗？

I have a .NET Web API project. I was able to add Swagger by installing the Swashbuckle NuGet package. Swagger now makes a nice web page that provides documentation and ability to test by going to this url: http://localhost:20475/product-catalog-api/swagger/ui/index This part works great. However, when I add FluentValidation and set it up in the WebApiConfig.cs, all of the requests to my site get high-jacked and instead of seeing the Swagger html page, I only get a JSON with an empty response.

I used this article by Matthew Jones to set up FluentValidation: http://www.exceptionnotfound.net/custom-validation-in-asp-net-web-api-with-fluentvalidation/

Here is what my web api config looks like:

I could trigger the FluentValidation manually in every web service method, but I would like to have a generic solution like Matthew Jones did with the Filters and MessageHandlers. Basically what I want to do is say IF the request is for swagger-ui then do not route through FluentValidation.