问题标签 [swagger-ui]

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 回答
2788 浏览

ruby-on-rails - 使用带有版本的葡萄时,Swagger ui 无法正常工作

如果我加载“ http://local.myproject:3000/api/swagger ”的内容

尽管我的版本是“V1”,但 api 端点显示为“/api/0.1/activities.json”

正是因为这个原因,当我推出“试试看!” 'swagger ui' 上的按钮请求无法执行,因为 api 的版本部分与实际版本不匹配。

这是招摇 UI 显示的消息的一部分:

0 投票
2 回答
1987 浏览

json - swagger-ui 和动态主机名

我有一个从模板动态生成的服务器,它公开了一个基于/api. 我只使用 HTTPS 访问它。如果我将其指定baseUrl为“/api”,swagger-ui 会尝试/api使用 HTTP 进行访问(并且我的浏览器会显示“锁定加载混合活动内容”)。

如果我给出https://hostname/apibasePath东西工作正常,但我不希望每个服务器的 JSON 文件都不同。

有任何想法吗?

谢谢,亚龙

0 投票
1 回答
3294 浏览

xml - 我可以在 Swagger UI 中为 XML 创建模型吗?

我正在研究 SwaggerUI 作为记录 ReST 服务的选项。该服务支持 XML 和 JSON 格式。

我可以在 pets 演示中看到,您可以使用 JSON Schema 为 JSON 对象指定模式。但是,我看不到使用 XSD 或 DTD 指定 XML 模式的方法。这可能吗?

0 投票
0 回答
60 浏览

servicestack - SwaggerUI 暴露字典输入错误的方式

亲爱的溢出者,我正在使用 SwaggerUI 来公开我的 servicestack REST 服务规范,但我遇到了一个意外问题。

我的一项服务接受类似的请求

但这是 SwaggerUI 公开请求对象的方式:

为什么会发生这种情况?我可以以某种方式修复它吗?

和平与密码 2 你们大家

0 投票
0 回答
2828 浏览

performance - Swagger UI 太慢了

最近我正在使用 Swagger UI 来制作 API Explorer。问题是,当我有很多数据时,UI 需要很长时间才能响应任何交互(即使我选择了任何文本,或者在文本字段中输入数据)。

你知道为什么并有什么建议吗?

0 投票
1 回答
6157 浏览

java - Swagger @ApiOperation 可以允许在 Java 中指定列表列表吗?

我在具有如下签名的 Java 类中有一个方法,我想为其添加 Swagger Rest 文档。

我想知道是否有办法让 response 或 responseContainer 返回 List 对象列表?像下面这样的东西?

如果方法的响应只是 List 我可以在其中指定 response =MyCustomClass.class , responseContainer = "List" 但只有当它是 List of List 作为返回类型时才会出现问题,我在生成 swagger 文档方面没有问题。

谢谢

拉维

0 投票
2 回答
1184 浏览

scala - Swagger for Play:DELETE 请求始终返回“Invalid Json”

我刚刚下载了 Swagger-UI 的最后一个发行版......在发送没有 JSON 正文的 DELETE 请求时,它看起来不再有效 - 请注意,这在以前的版本中运行良好。下面是我的注释:

每当我发送 DELETE 请求时,我总是会收到以下响应(错误请求):

同样,我没有修改我的源代码,如果我回滚到以前版本的 Swagger-UI,它会按预期工作。我错过了什么吗?万一有解决方法使它起作用?

0 投票
1 回答
3626 浏览

java - Swagger 中的重复条目

我正在使用 HalBuilder 库为HAL表示编写一个 API。

就目前而言,我需要为 JSON 和 HAL 表示提供两种不同的方法。例如,myVersionResource包括以下两种方法:

(注意:我确信有更好的方法来折叠这些方法,我正在寻找一种方法来做到这一点)

但我的直接问题是使用两种方法会导致我的 Swagger 文档中出现重复条目​​:

招摇用户界面

这两者GET /versions实际上是相同的东西,但是它们有不同的返回类型,所以 Swagger 希望它们不同。

我想把这两个折叠起来。我在这里有什么选择?

[可能值得指出的是,我正在使用 Swagger Maven 插件来生成我的文档。该应用程序还使用 Guice 进行 DI 和 Jersey 进行 JSON 表示。]

0 投票
9 回答
40185 浏览

java - 在 Swagger-UI 中对 API 方法进行排序

我找不到任何工作示例,如何实现以下目标:我希望 Swagger-UI 中的 API 方法按方法(GET-POST-PUT-DELETE)或/AND 字母顺序排序。

到目前为止,所有方法都以随机顺序显示,即使不是按照我的源代码给出的顺序。

我使用 Jax-RS + Jersey 1。

使用@ApiOperation 的位置属性进行排序对我来说不是一个选项,因为方法太多,API 仍在扩展,所以如果有新方法,我需要全部更新。

有什么提示吗?

0 投票
1 回答
783 浏览

spring - Apache Wink 与 Swagger 的集成

我正在尝试在现有的 Wink restful web 服务中使用 Swagger。我已经完成了 swagger 文档中提到的所有注释,但现在我需要整合其余的东西。例如配置 swagger UI,在服务器启动期间设置 swagger 配置等。任何人都可以向我指出任何文档或提供一些要遵循的步骤吗?