问题标签 [swagger-play2]

我正在尝试使用 Swagger 记录 Play 2 REST API，但swagger-play2似乎不理解使用 ScalaOption类型定义的可选参数 - 在 Play 2 中使参数可选的正常方法：

我希望q参数是可选的。此参数有一个匹配的带注释的控制器方法Option[String]。启动时，我进入UNKOWN TYPE日志，api-docs 生成的 json 中断swagger-ui：

是否有另一种方法可以在 Play 2 中指定可选参数并让 Swagger 理解它？

我能够使用Play设置Swagger并尝试 Swagger-ui ......我必须说它真的很棒。

ApiOperation用,等记录我的控制器的操作ApiImplicitPara很容易，并且可以按预期工作。

不过，由于我对 Swagger 的了解有限，在为 type 的隐式参数定义架构时遇到了问题body。我想映射到隐式参数的类如下所示：

我的模型类的内部表示是 JSON……然后我只提供读取/修改内部 JSON 的 getter 和 setter——这个解决方案让我可以非常快速地处理 JSON，并且我可以将对象按原样传递给 MongoDB。

问题是Swagger为上面的类生成的模型是这样的：

如何防止 Swagger 放入json模型？

我有一个文档案例类。为了对其进行序列化并在 Json 文本中反序列化，我定义了隐式 Reads 和 Writes 对象。

如果我的 Document 类只包含 Int 和 String，我没有问题。但是，当我的 Document case 类中有 Html 类型值时，我遇到了问题。

它是一种嵌套的序列化和反序列化。我在为 Html 创建阅读器时遇到问题。Play 2 Html 不是案例类。那是问题吗？

下面的代码是否正确：

这没用。我该怎么做？谢谢

有没有人尝试将 swagger 与 play 2 一起使用。我有 play 2 java 项目，我正在尝试将 swagger 与它集成，但没有任何运气。我使用此依赖项安装了软件包：

但我不断从路由文件中收到此错误：

知道如何解决吗？

我正在尝试将 swagger 与播放框架一起使用。

我在代码中添加了 API 注释，我可以通过

本地主机：9000/api-docs

但是当我尝试使用 swagger ui 探索它时，我无法扩展或列出操作。

在 swagger ui index.html 中，我进行了以下更改。

我是否缺少任何配置。请提供建议或指点。

我正在尝试使用 Swagger 来记录我的 REST API。按照这个例子，我像这样注释 REST 端点：

我期待得到“模型”，但我只得到字符串“CreateItemRequest”作为数据类型。不是案例类 CreateItemRequest 的属性。

问候，丹尼尔

使用 play 2.4 框架配置 swagger api 时面临问题。

按照这个网址进行配置：https ://github.com/swagger-api/swagger-play/tree/master/play-2.4/swagger-play2

配置后出现编译时错误消息“类型 ApiHelpController 不是包控制器的成员”，因为此 ApiHelpController.scala 文件存在于 app/controllers 包中。

有谁知道我错过了什么。

我正在尝试使用我的 Play-2.5 项目配置Swagger 。

我按照本教程进行了操作，但仅适用于旧版本的 Play，不适用于 Play-2.5。由于项目已经迁移到 Play-2.5，我们不得不删除 swagger 配置。

首先，问题似乎在于 Play-2.5 中的静态控制器与非静态控制器，但我最终证明自己错了。我正面临这个错误

如果有人知道使用 Play-2.5 for Java进行 Swagger 配置的任何链接，请指导。

PS：有适用于 Scala 而不是java的教程。

我正在使用 Scala 和 Play 2.5 开发微服务，并尝试使用 Swagger 记录我的端点。

我将 Swagger UI webjar 添加到我的依赖项中：

还有 Swagger Play2 插件：

注意：Swagger Play2 插件的 1.5.3 版本尚未正式发布。我从项目的 master 分支构建它，因为它是唯一可以与 Play 2.5.8 一起使用的版本，这是我正在使用的版本。

然后，我将以下内容添加到我的路线文件中：

通过这样做，我可以通过以下方式访问 Swagger UI：

http://localhost:9000/assets/lib/swagger-ui/index.html?/url=http://localhost:9000/api-docs

但是，这是一个巨大的 URL。我想将它简化为像根 (/) 这样简单的东西，但存在以下挑战：

1. 如何让 Play2 动态地将url参数传递给静态 HTML 页面？我如何才能将主机和端口调整为运行服务的服务器上的任何内容？我考虑过使用controllers.Default.redirect，但我找不到在参数字符串中插入主机和端口的方法。
2. 如何映射/并assets/lib/swagger-ui/index.html传递url参数？

当我多次调用同一个 API 并一个接一个地快速调用它时，我得到了 readystate undefined 和 status 0 作为响应。我的网页上有用于调用 api 的按钮，如果我在点击例如 3 秒时给出间隙，则 api 工作正常。我检查了后端 openAPI (swagger) 休息服务，即使我快速调用它也能正常运行。

因此，我尝试使用 readystate 进行一些测试，有趣的是，当 readystate 的输出为“未定义”时，readystate == 4 上的 if 条件起作用并将输出为“未定义”和状态“0”。查看最后一个 else if 条件。

但主要问题是为什么我在后端工作正常时得到未定义？如果延迟调用，api也可以正常工作吗？添加延迟很困难，因为最终用户可以单击屏幕上的按钮，而且我也不想要不必要的延迟。