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

c# - 基于 HttpStatusCode 的不同响应模型示例

我有的:

我有一个 API,其中所有不成功的响应都返回“IApiException”

如果我通过 ISchemaFilter 在 swashbuckle 中设置示例,它将在所有模型示例上放置相同的示例,因此 401 将返回与 429 相同的示例。

我想要的是:

我希望能够根据状态码返回不同的示例。

我试过什么:

我尝试创建一个 IOperationsFilter 来查找响应键,然后设置响应模式示例或响应示例。但它根本没有显示模型。

在此处输入图像描述

0 投票
1 回答
358 浏览

asp.net-web-api - 使用 swashbuckle 的多个前提条件失败注释

我正在使用swashbuckle记录我的 web api 项目,我无法为前置条件失败的情况添加多个响应,swagger 只显示最后一个。

Swashbuckle 生成如下内容:

我想看的地方:

有什么想法吗?

提前致谢

0 投票
0 回答
502 浏览

c# - Swashbuckle 路线问题

Swashbuckle 有一些问题,主要是路由问题。

因此,我正在使用一个 API,该 API 为某些定义了控制器特定的路由,并为所有其他人定义了一个通用的默认路由。两者都包含在路由规范中的默认值。

具体路线示例:

默认路由示例:

我遇到的问题:

  1. 由于通用路由处理程序是“包罗万象”的,因此 Swagger 会选择更具体的路由(在本例中为 Infobutton)和通用路由,这会导致 Swagger UI 中显示两个函数。

  2. 使用出现在默认值中的参数进行 Get 调用会导致 Get 调用根本不显示在 UI 中。

任何想法将不胜感激!

0 投票
0 回答
544 浏览

c# - Swashbuckle 复杂对象

给定一个对象参数,例如:

我知道如果您在参数前使用 [FromUri(Name="XYZ")] 可以让 Swashbuckle 在 UI 中显示 XYZ.listABC 然后在文本框中输入列表。

有没有办法在 UI 中公开列表对象 ABC,而不是为 XYZ.listABC 提供通用文本框?

0 投票
1 回答
100 浏览

c# - Swagger doc 停止使用 swashbuckle 生成

我已经使用 swagger docs(使用 swashbuckle)开发 WebApi2 REST API 有一段时间了,但是在我的本地沙盒版本中,我无法通过 GET 请求访问 SwaggerUI,也无法访问 swagger xml。我已经比较了我的代码版本之间的 swagger 设置,并且在这方面没有任何代码更改。我已经卸载了 swashbuckle 和 IISExpress,没有任何效果。我的想法已经不多了,我希望能在接下来的步骤中提供一些建议,以尝试调试 swagger 生成/或找出是否有任何日志记录,我可以进一步打开帮助诊断。

很抱歉发布这样一个普遍的问题,但我现在看了大约 5 个小时后不知所措。

谢谢

标记

0 投票
1 回答
9683 浏览

c# - 在 SwashBuckle 中使用 IOperationFilter 删除路由

我正在寻找一种在 Swagger 文档中以可配置的方式使用 SwashBuckle 显示/隐藏 WebAPI 路由的方法。添加[ApiExplorerSettings(IgnoreApi = true)]确实会隐藏路线,但每次我想要更改时都需要重新编译。

我已经研究过创建一个IOperationFilter以使用我定义的自定义属性。这样我可以用 a 装饰路线[SwaggerTag("MobileOnly")]并检查 web.config 或其他东西以查看是否应该显示路线。属性定义如下:

IOperationFilter定义检测属性的和删除IDocumentFilter路径的定义在这里:

并注册为:

我觉得当我更早地访问它时,标记一些东西以便稍后删除它是低效和hacky的。有什么方法可以让我从内部删除路线IOperationFilter.Apply而不是等待IDocumentFilter并扫描它?

0 投票
5 回答
16358 浏览

asp.net-web-api - 对 Swagger UI 标头的修改

我使用 Swashbuckle 和 Swagger API 创建了个人 WEB API。

虽然我能够成功集成它,但我想修改 Swagger 的默认 UI。更改标题的颜色并替换招摇的图像。

附上我想改变的想象部分。

这可以通过修改现有文件来实现吗?

0 投票
1 回答
939 浏览

asp.net-mvc - 查找 Swagger UI 网页的视图

我创建了一个集成 Swashbuckle 和 Swagger UI 的新 WEB API 项目。

我可以通过http://localhost:port/swagger/ui/index#/访问 Swagger 网页

但是,这个页面的 view/index.html/index.cshtml 在哪里?我是MVC的新手,请帮忙。

0 投票
2 回答
1695 浏览

asp.net-web-api2 - 自定义 swagger ui 以分离文档

我已经使用 swashbuckle 5.x 和 swashbuckle-Odata 将 swagger 集成到我的 Web API/OData 项目中。如果我导航到http://root_url/swagger,我可以在一个大列表中看到所有可用的 API 文档。每件事都很好,但我已经给出了一个Odata 控制器和 API 的列表,我需要在单独的列表中显示它们。我知道这是我需要通过为 swagger 创建一个自定义 index.html 并注入 swaggerconfig.cs 来做的事情

我一直在互联网上研究如何分离 swagger 文档,以便我可以创建一个不同的 HTML 列表并获得我的结果,到目前为止还没有运气。有没有人做过类似的事情?你能给我一些建议或指示我需要从哪里开始吗?

我正在尝试在我的招摇文档中实现以下结构。

0 投票
24 回答
151826 浏览

c# - Swagger UI Web Api 文档将枚举呈现为字符串?

有没有办法将所有枚举显示为它们的字符串值,而不是它们的 int 值?

我希望能够提交 POST 操作并根据其字符串值放置枚举,而不必每次都查看枚举。

我尝试过DescribeAllEnumsAsStrings,但服务器随后接收字符串而不是我们正在寻找的枚举值。

有没有人解决这个问题?

编辑: