问题标签 [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 投票
4 回答
41160 浏览

swagger - 如何在 Swagger UI 中发送带有请求的授权标头?

我有一个 ASP.NET Web Api 2 应用程序。我在其中添加了 Swashbuckle(Swagger for .NET)。它显示我的端点没有问题,但为了发送请求,我需要将 Authorization 标头附加到该请求。如果我理解正确,我需要修改 index.html 文件(https://github.com/swagger-api/swagger-ui#how-to-use-it)所以我 git 克隆了 Swashbuckle 项目为了修改 index.html 并添加一些标题。

这是在 Swashbuckle 中随请求发送 Authorization 标头的唯一方法吗?

0 投票
1 回答
2009 浏览

c# - 带有 ModelBinder 的 Swashbuckle 和 Web Api 方法

我有一个 C# WebAPI 项目,其方法使用自定义 ModelBinder 作为其输入参数。当我查看 Swashbuckle 生成的 Swagger UI 时,该方法参数的所有属性都单独列出,而不是具有单个“body”参数。如果我摆脱 [ModelBinder] 属性并切换到使用 [FromBody] 属性,Swagger UI 会显示正确的内容。我必须使用 [ModelBinder] 属性,因此不能将其切换出去。

有没有办法让 Swashbuckle 生成“[FromBody] 属性样式”单个参数而不是它正在执行的多个参数?

0 投票
2 回答
8884 浏览

c# - 在 Web API 的 Swagger 文档中支持基于令牌的身份验证

我正在尝试 swagger( SwashBuckle ) 来生成 web api 文档。我已经使用 swagger 成功生成了使用 Web API 文档的文档,但我无法成功发送 API 请求,因为我们对少数方法具有基于令牌的身份验证(用于身份验证目的的自定义标头)。

我试图找出相同的示例代码/资源,但运气不佳。如果有人在他们的应用程序中实现/遇到类似的事情,请告诉我。

0 投票
1 回答
1200 浏览

asp.net-mvc - 使用 Swashbuckle 托管现有的 Swagger.JSON 文件

我有一个 .NET WebApi 站点的现有 Swagger.json 文件,我想将它与运行 Swashbuckle 的开发人员站点(位于不同的 url)集成。

我可以简单地将这个 swagger.json 文件复制到 mvc 站点(内容或 app_data 文件夹并执行此操作吗?)

如果可以的话,放在哪里最好。如何将其设为主机提供的默认 swagger 文件?

0 投票
2 回答
8193 浏览

attributes - 通过属性版本控制在 Swagger 中利用 MultipleApiVersions

使用属性路由时是否可以在 Swagger UI / Swashbuckle 中利用 MultipleApiVersions?

具体来说,我通过以下方式实现了版本控制:

版本 2 将位于 v2 命名空间中。在名为 TestV2Controller 的控制器中。该路线将包含 v2。

是否可以传递一个允许这样做的 lambda?我在网上找到了一个编译的示例 lambda,但随后 Swagger 完全停止工作。无法在浏览器中设置断点或查看 Swagger。

0 投票
1 回答
678 浏览

swagger-ui - Swashbuckle Swagger UI FormData 类型未定义

在此处输入图像描述

我正在使用 Swashbuckle 5.1.5 作为我的其余 API 来上传图像,但表单数据参数数据类型出现为未定义。如何设置数据类型?

0 投票
2 回答
5835 浏览

c# - 更改通过 .NET Web API 2 中的 Swashbuckle 生成的 Swagger JSON 的参数名称

目标:我正在设计一个允许用户为 HTTP GET 请求的查询字符串传递参数的 REST API。就像是

实现:在服务器端,我有一个模型绑定器,它接受这 3 个参数 - api-key、term 和 rows 并将它们转换为 C# 对象,这样我的控制器操作方法就不必解析查询字符串。所以控制器动作方法签名看起来像

问题:我在使用 Swagger 时遇到的问题是,当它生成文档和测试工具时,它会将输入参数列为 request.api-key、request.term 和 request.rows。这是因为它从服务器获取的 JSON 将对象名称作为这些值的前缀。因此,当您尝试使用 Swagger UI 执行 HTTP GET 请求时,它会构建类似的 URL

这是对服务器的错误请求。现在我可以轻松地让我的模型绑定器更智能,从而忽略“请求”。部分,但这似乎是解决此问题的一种落后方式。

问题:如何在服务器端自定义由 Swashbuckle -> Swagger 生成的 JSON,以便此特定对象的参数名称不以对象名称为前缀?我确实研究了 Swashbuckle 可扩展性 API 公开的 ISchemaFilter 和 IDocumentFilter,但我没有看到一个干净的方法来做到这一点。也许这是可能的,但在这种情况下,一个例子会有所帮助。

0 投票
4 回答
11674 浏览

swagger - Swagger (Swashbuckle) 隐藏页眉

我使用 Swashbuckle 将 Swagger 文档添加到我的 ASP.NET Web API 项目中。如何在不注入 CSS 的情况下从文档页面隐藏默认标题(带有 swagger 徽标)?

0 投票
4 回答
11635 浏览

asp.net - 完全替换 Swashbuckle UI

现在我正在开发一个 ASP.Net Web API 并使用 Swashbuckle 作为它的文档。我知道 Swashbuckle 内部使用 Swagger-UI,我知道我们可以通过注入我们的 css 或 javascript 文件来修改布局,甚至改变 index.html 的布局。

我为 Swagger-UI https://github.com/jensoleg/swagger-ui找到了一个很好的主题并尝试实现它但无法使其工作。特别是当我想注入 bootstrap.js 时。无论如何我可以完全改变 Swashbuckle Swagger UI 实现,以便我可以使用该回购中的解决方案吗?

0 投票
1 回答
1493 浏览

rest - Swagger 给对象引用错误

在 VS2013 WebAPI 项目上运行 swagger 时,出现以下错误

完成的步骤 1.安装 SwashBuckle Nuget 包 2.修改 Swagger.cs 文件以包含所需的基本代码。3.运行WebApi。4. 在 API url 中附加 /swagger。

执行第 4 步后,出现上述错误。

请帮忙。