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

asp.net - 使用 Swashbuckle 和 ASP.NET Identity 限制对 Swagger 中某些 API 控制器的访问

所以,我开始使用 Swagger。我绝对爱上了它的功能,但我对所有公开方法的可用性有一些疑问。

据我了解——Swaschbuclke“auth”方法中包含的所有内容实际上都是关于 API 本身的,但我不需要帮助——我所有的 API 都受 API id/key 对的保护。

我想以某种方式利用 ASP.NET 身份(登录系统)来限制对 API 页面(/swagger/ui/index)的访问。

有什么办法吗?Swaschbuckle 中的任何方法?任何路线/身份黑客?

任何帮助表示赞赏。

编辑1:[ApiExplorerSettings(IgnoreApi = true)]属性不是我要找的——它限制了对方法的所有访问,无论身份如何。

0 投票
3 回答
4409 浏览

unit-testing - 单元测试招摇输出

我在 ASP.NET MVC WebAPI 项目中使用 Swagger。该项目安装了 Swashbuckle nugget 包并生成 Swagger UI 和 Swagger/docs/v1。我遇到的一个始终如一的问题是开发人员会通过不仔细命名他们的 webAPI 操作来破坏 swagger 文件。我想添加一个单元测试,以防止我通过在部署后转到 Swagger UI 站点并看到在 swagger UI 中显示的 HTTP 500 来发现 swagger/docs/v1 不可用。有人知道如何编写单元测试来验证 Swashbuckle 可以成功生成 swagger 文档吗?

0 投票
0 回答
521 浏览

.net - Swagger(Swashbuckle)UI 未从远程主机加载

我已经在 .NET Web API 项目上实现了 Swagger(通过 Swashbuckle),并且在从 localhost 运行时一切正常。但是,当我在远程计算机上通过 IIS 托管时,UI 加载速度非常慢(1 分钟 +),并且只加载标题,而不加载端点。

我在 IIS 中为该站点启用了 CORS,并在“EnableSwagger”方法中添加了以下扩展;

我假设有某种路径解决问题,但我不知道它是什么。有任何想法吗?

0 投票
1 回答
1907 浏览

swagger - Swashbuckle 自定义字符串比较器不适用于操作的订单组

在 Swashbuckle 中有一个名为 OrderActionGroupsBy 的设置,它应该更改 API 中的排序,但我所做的一切都不起作用,我无法确定这是否是 Swashbuckle 问题,或者由于我的 IComparer 知道我是什么我做错了吗?

这是设置配置

这是按类型而不是控制器名称对操作进行分组。

这是我对 IComparer 的尝试,我首先希望用户,然后按字母顺序排列

这不起作用,无论我做什么,它总是默认为字母顺序。

0 投票
1 回答
2324 浏览

sorting - 覆盖 Swagger 排序

我想以相反的字母顺序组织我的 swagger api,但它默认为字母顺序。有没有一种简单的方法可以做到这一点?具体使用 Swashbuckle.Core 5.2.1

0 投票
2 回答
15794 浏览

oauth-2.0 - 在 Swashbuckle 中启用 Oauth2 客户端凭据流

我使用 IdentityServer3 来保护具有客户端凭据授权的 Web API。对于文档,我正在使用 Swashbuckle,但无法弄清楚如何在 SwaggerConfig 中为客户端凭据(应用程序)流启用 Oauth2。任何帮助,将不胜感激!

0 投票
1 回答
1485 浏览

express - 像 swagger/swashbuckle 但对于 node.js?

是否有任何用于 node express 的工具,您可以在其中为现有项目自动生成 swagger 文档?类似于花花公子?

0 投票
1 回答
1960 浏览

asp.net - Swashbuckle 承载授权

我有一个 ASP.Net 应用程序,它使用 Swashbuckle 并查看文档一切正常,直到另一个开发人员使用 JWT 设置一些授权逻辑并且需要在每个标头请求中传递“授权承载”。在实施之后,我什至无法查看 /44300/swagger 的文档。它只是说无效的凭据。我有能力生成一个命中 /api/security 端点的令牌,但是我如何配置 Swashbuckle 以获取/使用令牌只是为了加载文档页面。这真是令人沮丧,因为我在网上找不到任何信息。

同样,我不想通过 Swashbuckle 达到端点。我只是想点击 URL 来查看文档,但它不允许我

0 投票
1 回答
276 浏览

swagger - swashbuckle 生成无效的字段名称

看起来像 swashbuckle (5.2.2) 生成无效的字段名。我有一个(部分)看起来像这样的模型,所有属性都有一个后缀为“Field”的支持字段

控制器方法签名如下所示:

生成的文档如下所示:

在此处输入图像描述

它使用私有字段的名称而不是使用属性的名称。这是预期的行为吗?有什么办法可以解决这个问题并获得实际财产吗?

0 投票
6 回答
32375 浏览

c# - swagger-ui 部署后返回 500

开箱即用的配置在我的机器上完美运行,完全没有问题。

但是当我部署到我们的测试环境时 - 我收到以下消息

500 : { "Message": "发生错误。" } /api/swagger/docs/v1

在此处输入图像描述 部署是为了default web site/api

我猜它与 baseUrl 或类似的东西有关,但我什至不知道从哪里开始。

我的路由在项目中运行良好——我可以调用我所有的 webapi 端点并且它们响应正确。

任何帮助将非常感激