问题标签 [swashbuckle]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1113 浏览

swagger - Swagger/Swashbuckle 嵌套响应未正确显示

我正在尝试从 Swashbuckle 4 升级到 5 并将 1.2 升级到 2。

我遇到的问题是,如果响应中包含另一个对象,则响应模式无法正确显示。

在使用 Swagger 1.2 时,我的模型架构如下所示:

模型是:

现在模型模式是:

模型是:

JSON 并没有真正改变。从 swagger 1.2 到 2.0,响应类型已从 type 移动到响应 ref,但 JSON 似乎是正确的,如果 Preferences 或 address 未嵌套在 Customer 中,它会正确显示在 UI 中。

如何让地址和偏好的模型出现在客户模型中?

0 投票
2 回答
120 浏览

swagger - Swagger 2.0 模型中的字符串显示为“”

我正在升级到 swagger 2.0,在我的模型的 UI 中,我希望字符串显示为“”。

现在模型模式看起来像

我希望它看起来像

有没有办法在 swagger 2.0 中设置它?

0 投票
1 回答
2292 浏览

iis - 使用基于 katana-owin 的 Web api 运行的 Swashbuckle 不适用于 IIS,但适用于 IIS Express

我想我有一个类似的问题,因为这个 post -Webactivator 不在 IIS 7 上运行

使用基于 katana-owin 的 web api 运行的 Swashbuckle 能够与 IIS Express 一起使用。

假设下面的所有 url 都有一个“http”前缀。我可以浏览到类似 localhost:8085/swagger 的内容,它将我正确重定向到 localhost:8085/swagger/ui/index

但是当发布到 IIS 时,重定向到 localhost/swagger/ui/index 而不是 localhost/myapp/swagger/ui/index ,这会导致404。请注意,即使在以某种方式发布时指定了应用程序名称 swashbuckle/swagger 也不知道并且只使用没有应用程序名称的路径库。

基本上它只是获取站点根 URL 而不是用于调用 /swagger 的应用程序 URL

这个问题有什么解决办法吗?

0 投票
1 回答
33924 浏览

c# - 当从另一个项目内部提供 api 时,如何在 Swashbuckle/Swaggerwork 中创建 url 路径?

全部。我正在尝试使用 Swashbuckle 包记录 WebApi 2。

如果 API 自己运行,那么一切都很好,即localhost/api/swagger将我带到 ui 和localhost/api/swagger/docs/v1到 json。

但是,生产应用程序通过在另一个 Web 项目(主应用程序之一)中从 global.asax.cs 运行该项目的 webapiconfig 方法来初始化同一个 Webapi 项目。所以 api url 看起来像localhost/web/api而不是 localhost/api。

现在 swashbuckle 根本不像那样工作。

  • localhost/api/swagger 生成错误 cannot load 'API.WebApiApplication', 当然可以
  • 本地主机/网络/招摇= 404
  • 本地主机/web/api/swagger = 404

我试图到处寻找,但我发现的只是解决方法。

不幸的是它不起作用,现在也许它应该,我只需要改变一些东西,但我什至不知道这个属性究竟期望什么以及应该设置什么。

可能它甚至不适用 - 也许我们的设置需要其他东西或一些花哨的代码更改。

我将不胜感激您能提供的任何帮助。我真的开始喜欢大摇大摆(和 swashbuckle)的其余文档。

0 投票
3 回答
4839 浏览

asp.net - 带有 ASP.NET v5 Azure Api 应用程序的 Swagger

我正在尝试使用 Swagger + Swashbuckle 设置 Api 应用程序(Azure),正如 Scott Hanselman 在 //Build 会议上所展示的那样:http: //channel9.msdn.com/Events/Build/2015/2-628

我已经安装(使用 NuGet)包 Swagger.Api 和 Swashbuckle.Core。它没有添加任何我期望的控制器或设置,以便拥有一个招摇页面。当我导航到 {baseUrl}\swagger 时,我收到 404 错误。

我认为,由于它有一个 UI,除了 Api 应用程序之外,它还需要一个 Web 应用程序,但我重新观看了演示,Scott 明确表示您可以将 Swagger + Swashbuckle 添加到任何 Api 应用程序。在第二个应用程序中,虽然我认为 Api 发现可能存在问题。有人设置成功了吗?

大摇大摆的项目

0 投票
1 回答
3761 浏览

c# - Swashbuckle 的自定义路线

我正在尝试为 swashbuckle 注册自定义路线。但是我无法弄清楚这一点。

我需要做的是为当前路由添加一个扩展。

因此,例如:我需要将其设置为 swagger.aspx/ui.. 而不是 swagger/ui。这是因为我的应用程序将托管在我无权访问且运行 IIS6 的服务器上。

有任何想法吗?

我努力了:

但是没有成功... :(

0 投票
1 回答
2127 浏览

swagger - Swagger:支持可选路线

我有一条带有可选参数的路线:

但是,当我没有为请求本身提供categoryId调用的值时......{categoryId?}

0 投票
1 回答
280 浏览

swashbuckle - 将 Swashbuckle (swagger) 导入 3scale ActiveDocs

我们目前在 .net (webapi) 上使用 Swashbuckle 记录了我们的 api,有什么方法可以将此文档导入 3scale ActiveDocs?

提前致谢

0 投票
2 回答
5687 浏览

asp.net-web-api - 带有 swashbuckle api 文档的 http 基本身份验证

谁能知道我如何将基本身份验证与 swashbuckle api 的文档集成?

我看到swaggerconfig文件中有一个basicAuth函数:

我做了什么:

  • 取消注释前一行,但没有任何改变!

有谁知道我错过了什么?

谢谢!

0 投票
2 回答
2130 浏览

asp.net-mvc - .NET MVC Swashbuckle 由 Basic Auth 门控

有没有办法在 Basic Auth 属性后面控制 SwashBuckle 文档页面?所以只有拥有正确用户名和密码的人才能看到文档页面。

斜扣配置有

但它创建了自己的 MessageHandler,因此我无法附加我的基本身份验证属性,该属性实现为ActionFilterAttribute.

我也不希望将基本身份验证应用于整个站点,而只是大摇大摆的端点