问题标签 [swagger]

如何使用 GAE+Jersey+Maven 设置 Swagger（记录 API）？

我在 pom.xml 中包含了依赖项

在 web.xml 中：

其中 ServiceConfig 类是：

我目前正在使用 Swagger 记录 Play 2.1 应用程序。我设法让它编译成功，但它没有显示任何关于生成的 JSON 的信息。

本地主机：9000/api-docs.json

本地主机：9000/api-docs.json/items

这是控制器对象的注释：

这些是控制器方法的注释：

这些是 application.conf 上所需的配置：

上面显示的代码遵循 Swagger 的文档提供的示例应用程序。您知道 Play 2.1 上的任何工作示例吗？关于什么是错的或缺少什么的任何线索？

提前致谢。

编辑：路由文件部分：

应该如何为Swagger建模此类以正确解释它？

我不能简单地这样做：

这也没有任何意义：

全部，

我已经查看了 SO 中关于使用 root 时 ServiceStack 中的 Swagger 支持的所有问题，但我仍然想出一个 Handler for Request not found error for localhost:63219/swagger-ui/index.html

• VS2010
• 空 Web 项目（不是 MVC）
• ASP.NET 4
• 服务栈 3.9.55

我与此问题有关的所有文件都位于此处：https ://gist.github.com/bp4151/c7544218b15b7d770f80

我确定我错过了一些东西。如果有人可以帮助我，我将不胜感激......

谢谢，乙

我在使用 ServiceStack 大摇大摆地显示正确注释时遇到问题。

鉴于这种结构：

它正在生产：

我希望参数列表只有 WidgetId，但它显示 WidgetId 和 UpdageReqWidget，即请求的类名。任何想法我做错了什么？

编辑：我为 ServiceStack 和 ServiceStack.API.Swagger 使用 3.9.55 版本。我已经更改了模板以更好地满足我们的需求。

我对Swagger很陌生，所以我可能有一些细节错误。Swagger 似乎是一个很酷的生成 REST 文档的工具。但是，我不喜欢它非常具有侵入性并且需要我在我的 java 类上添加注释。我发现这个名为swagger-jaxrs-doclet 的maven 插件似乎生成了这些 json 文件，我应该能够将这些文件传递给 swagger 以生成 swagger 文档。优点是我不需要在我的任何类上放大张旗鼓的注释。

不幸的是，swagger-jaxrs-doclet 文档没有告诉我下一步该做什么。有人可以告诉我如何获取 swagger-jaxrs-doclet 的输出并从中生成 swagger 文档吗？我需要在 Maven 中执行此操作。

我正在尝试使用服务堆栈实现 Swagger。我已经使用 nuget 大摇大摆地安装了服务堆栈。当前的 DLL 版本大多报告为 3.9.56.0。

我正在尝试遵循... https://github.com/ServiceStack/ServiceStack.UseCases/tree/master/SwaggerHelloWorld提供的示例

并且指令看起来相当简单......

通过 nuget 安装后进入“配置”方法（如文档所示），然后我添加了 [ApiMember] 和 [Api] 标签，以及对 [Route] 标签的更改以添加摘要和注释

但是当我访问时~/swagger-ui/index.html我得到了错误

我的 api 位于~/api，而我目前只有一个方法（Hello World）位于~api/Hello/{name}它返回 JSON 并且工作正常。

如果我访问~api，我会收到消息Handler for Request not found:带有堆栈跟踪类型输出的消息。

我究竟做错了什么？启用 swagger 的说明看起来非常简单，并且似乎缺少详细说明，可能是因为它应该“正常工作”，请帮助！

更新以解决 Esker...

堆栈跟踪@myhost:54011/api

此外，“请指定协议”是一个大摇大摆的错误，显示在屏幕上前面提到的“更改发现 url 的文本框”下方的 html 中

并且 DLL 版本“大部分”相同，因为 ServiceStack.Redis 是 3.9.57.0 版，但我没有使用它，所以“大部分”

更新...我的解决方案

我在标签内的 web.config 文件中需要这个<configuration>，我之前没有包含这个<location path="api">位。

也......我已经设置了我的“路线”......

但这与 swagger 的功能相混淆，它需要......

删除了“api”位，现在一切正常。

我正在使用反射来获取所有具有 Api 注释的类，其中包含以下代码。

如果我从 Eclipse 运行服务器，一切正常并getTypesAnnotatedWith返回正确的类。但是，如果我从命令行运行服务器，我将获得该包之外的类。来自 Swagger 库的类。

我试图找出发生了什么而不是四处走动

提前致谢！

我对 RESTful 服务还很陌生，我刚刚实现了测试代码以使 ServiceStack RESTful 服务与 Swagger 插件一起工作，这让我想到了我的问题......

在 swagger-ui/index.html 中有一个“api_key”字段。我知道变量名是 umm... 变量，我也可以随意设置它，但我有点困惑它的用途以及我是否应该使用它。

另外，如果我确实使用它，servicestack 如何在服务器端向我呈现该值？

这是我从文档中启动并运行的测试服务...

我正在尝试在 Windows 7 x64 上构建swagger-codegen 。当我不得不跑步时遇到了问题./sbt assembly。我无法从 Windows 命令提示符中看到如何执行此操作。

相反，我从 Git-Bash 运行它。它运行成功，有警告，但没有错误。

这是一个可接受的解决方案吗？

我问是因为我被困在为 petstore 运行模板客户端的下一步。

./bin/scala-petstore.sh产生以下错误：

Error: Could not find or load main class Files