swagger-ui相关内容

在 swagger-ui 中使用多个 Json 文件

我正在使用 Swagger-ui 2.1.4 版,我在本地托管了它并提供我自己的 Json 文件和 API,它可以很好地打开文档并列出 json 文件中的所有方法,但是 json 文件变得非常大,我想使用多个 json 文件并希望一次打开一个,我愿意不知道如何提供多个 json 文件并使用它们,因为我在索引页面中提供的单个文件是这样的: var url = window.location.se ..
发布时间:2021-09-01 20:18:16 其他开发

隐藏示例值中的字段,但不在 Swagger UI 中的请求正文模型中

我们正在尝试在 Body 部分的 Swagger UI 上实现一个场景.在请求部分,我们是否可以使用示例值 JSON 隐藏一个或多个字段,但模型仍会显示这些字段? 我们基本上是在尝试减少请求正文中的字段数量,但让模型中的所有字段都可见. 例如,我们想隐藏示例中的 name : 但仍然在此处显示模型中的name: 解决方案 要在 Swagger UI 中从自动生成的模型示例 ..
发布时间:2021-09-01 20:18:07 其他开发

如何将 ref 用于示例 Swagger?

JSON 规范: “响应":{“200":{"description": "Успешный ответ сервиса",“架构":{"$ref": "#/definitions/BaseResponse"},“例子": {“应用程序/json":{“状态":真实,“回复": {"$ref": "#/定义/产品"},“错误":空}}}} 结果: 但我需要: {“状态":真实,“回复" ..
发布时间:2021-09-01 20:18:02 PHP

Swagger 不解析 @XmlElementWrapper 注释

我正在使用 Swagger 为我的基于 jax-rs 的 API 生成文档.在我的一个模型中,我具有以下属性: @XmlElementWrapper(name = "clip_list")@XmlElement(name = "剪辑")公共列表mClips = new ArrayList(); 但是在 UI 中生成的 JSON 模型如下: “剪辑":[{“期间":"","网址":"" ..
发布时间:2021-09-01 20:17:50 Java开发

如何隐藏不受 ServiceStack 的 SwaggerFeature 控制的路由?

在我的示例中,我使用了 ApiKeyAuthProvider 和 RegistrationFeature,,它们都向我的元数据添加了新路由. 我想使用 swagger 作为这些服务的主要文档,但我不希望 /AssignRoles 之类的东西出现在那里. 我正在探索 OperationFilter,但我很难弄清楚在那里做什么. 如何隐藏这些不需要的路由? 解决方案 您可以添 ..
发布时间:2021-09-01 20:17:47 其他开发

防止 Swagger 自动添加某些模型

我使用 Spring Boot 框架构建了一个 REST 接口.然后,我使用 Swagger 2.9.2 版来生成文档.从下图可以看出,Swagger 自动检测了很多模型. 然而,它们中的大多数都是多余的.其中,只有ResponseMessage是必须的,其余都是标准Java类. 所以,我的问题是:我如何告诉 Swagger 要公开哪些模型? 这是我的控制器的 Swagger 配 ..
发布时间:2021-09-01 20:17:25 Java开发

如何在 SwaggerUIBundle 中设置请求拦截器?

在我们的 swagger.json 中,我们将 basePath 设置为 /api,但是,当应用程序部署在 docker 容器中时,上下文路径不是/api.这可能是不同的事情,我们不知道它是什么,所以我们不能对其进行硬编码. 我正在尝试按照以下指南设置 requestInterceptor,以便捕获请求并修改 url 路径: https://swagger.io/docs/swagge ..
发布时间:2021-09-01 20:17:11 其他开发

Swagger 标头定义

我似乎无法找到是否可以声明一个标头对象以便在响应标头中重用它,有一些示例定义了响应模式的对象,但它不会转置为响应标头.我只设法制作了这样一个可重用的响应对象: 响应:下载确定:描述:下载好标题:内容长度:描述:响应长度类型:整数文件长度:描述:文件长度类型:整数 但正如我所说,我只想保留标题部分. 这里是我想使用它的地方: 回复:200:描述:下载好标题:$ref: '#/defin ..
发布时间:2021-09-01 20:17:08 其他开发

用于 net core 3.1 api 的 Swagger UI 非常慢

我将我们的网络核心 API 应用程序从 2.1 更新到 3.1,将 SwashBuckle.Asp.NetCore 更新到 5.0.0.这是我的启动集: 公共类启动{公共启动(IConfiguration配置){配置=配置;}公共 IConfiguration 配置 { 获取;}//这个方法被运行时调用.使用此方法向容器添加服务.public void ConfigureServices(ISe ..
发布时间:2021-09-01 20:16:39 C#/.NET

有选择地禁用“试用"在 swaggerUI 中

虽然这里有一个关于这个话题的长时间讨论:https://github.com/swagger-api/swagger-ui/issues/156 我还没有找到一种更简洁的方法来“有选择地"禁用“试用"按钮.我想为我的 API 的所有 POST 方法禁用它. 先谢谢你 解决方案 Swagger UI 3.10.0+ 和 2.x 提供了 supportedSubmitMethods ..
发布时间:2021-09-01 20:16:23 其他开发

如何防止 Swagger-ui 中的 xml-wrapper 元素

我使用的是 swagger-ui 版本 2.2.8 我们现有的 API 可以生成 application/json 以及 application/xml. 对于 json 中的单个记录结果,它会生成: {“人": {“身份证":23,“姓名":“约翰"}} 对于它产生的 XML: 23约翰 我的招摇模式是: {“人": {“类型":“ ..
发布时间:2021-09-01 20:16:16 其他开发

在不同的项目中显示 API 的 Swagger UI (Swashbuckle)

我们有一个包含 2 个项目的 .NET 解决方案: ASP.NET MVC 门户项目 OWIN 主机 API 项目(带有自定义控制器选择器) 我们正在尝试向基于 OWIN 的 API 项目中的一些 API 控制器公开一个公共文档我们想为 API 项目中的控制器展示 Portal 项目中的 Swagger UI 到目前为止,所有尝试都没有成功.将 Swagger UI 添加到 P ..
发布时间:2021-09-01 20:16:00 其他开发

Swagger 文档中未显示 WebApi 控制器摘要

当我通过 Swagger 启用此文档功能时,我可以查看有关我的文档的所有类型的信息,但没有关于我的控制器名称详细信息/描述的详细信息. 如何像下面的例子那样显示控制器文档内容? ///////表示警报api控制器类.///公共类 XYZController : ApiController{} 在启用 swagger 时,我无法在 代表 XYZ api 控制器类的任何地方看到此内容.这里 ..
发布时间:2021-09-01 20:15:23 其他开发

Swagger (Swashbuckle) 隐藏标题

我使用 Swashbuckle 将 Swagger 文档添加到我的 ASP.NET Web API 项目中.如何在不注入 CSS 的情况下从文档页面隐藏默认标题(带有 swagger 徽标)? 解决方案 不幸的是,我认为您现在可以通过 javascript 来完成. 在您的 SwaggerConfig.cs 中,您可以像这样注入 .js 文件: .EnableSwaggerUi(c ..
发布时间:2021-09-01 20:15:20 其他开发