问题标签 [swagger]

我是 Play2 框架的 android/java 开发人员。我正在尝试使用swagger为我的 RESTful API 生成文档。

我设法将 swagger 包含到我的 Play2 webapp 中并生成简单的 api-docs.json。我唯一缺少的部分是模型描述。我在 /controllers 和 /models 中有相应的用户控制器和用户模型。

我试图完全按照示例注释模型

结果是：

有任何想法吗 ？

我正在尝试在 OSX 10.7.5 上使用source2swagger

它取决于“json”，所以我正在安装它，然后尝试如下运行。

谁能告诉我这里有什么不工作以及如何让 source2swagger 看到“json”？

source2swagger 在一个 json 文件中生成一个包含所有 api 的 swagger 规范。swagger-ui 真的可以使用它吗？当我使用 swagger-ui 探索生成的 json 文件时，它会尝试从规范中的路径读取 api 描述，而不是使用单个 json 文件中的描述/操作。

我正在使用 JBoss AS 7.1.1、RestEasy 2.3.5.Final、Swagger 1.2.0、Spring 3.1.1

这是我的 web.xml，

spring application-context & servlet-context.xml 很好，我的 REST 服务已连接并正常工作。但只有招摇是行不通的。这是 ApiListingResource，

我检查了 @Context 注入在 RestEasy 2.3.5 中不起作用。无论如何创建了一个自定义配置阅读器，

当我尝试访问时，我总是收到 NPE 错误http://localhost:8080/js/api-docs

在 Swagger API 文档中，在 apis 数组旁边的 json 中有一个模型对象条目，但没有关于它的文档。我怎样才能使用这个“模型”部分？

我正在尝试实现类似 http://petstore.swagger.wordnik.com/#!/store/placeOrder_post_2 我想定义自定义 DataType 以在属性DataType参数中使用它，ServiceStack.ServiceHost.ApiMember以便 ServiceStack 生成模型和模型架构部分我，就像上面的网址一样。

我怎样才能做到这一点？

我有一个简单的会话对象，看起来像这样

当我去大摇大摆的 UI 时，我可以看到元素

但是，当我输入元素并按 Try it now 时，我看到请求内容没有发送到服务器。

我是否使用 parameterType="path" 正确配置了我的 poco，还是应该在这里做其他事情？请指教。

服务堆栈是否支持 Swagger 中的模型。在下面的示例代码中

我希望 UserData 是复杂类型或容器类型。但是，如果我将其定义为其中之一，我在 SwaggerUI 中得到的只是一个文本区域框。我没有得到我在 petstore 在线示例中看到的 Model 和 ModelSchema 链接。

http://petstore.swagger.wordnik.com/#!/pet/addPet_post_1

我正在实现一个 RPC 类型的 API 应用程序。我在播放框架上使用 Java。我已经使用 swagger 模块为简单的 rest API 生成 swagger 文档，其中每个“URL”映射到我的控制器中的不同静态函数。但是在这里我需要将一个 URL 和一个静态函数映射到 API 文档中的多个操作。

基本结构相当经典

每个动作都映射到我的 RPCController 映射器中的相同静态函数，就像在 play 框架的路由文件中一样

/rpc/ 路由.RPCController.rpc()

如何使用 swagger 和 swagger-core 文档生成记录所有操作、参数类和结果类？是否可以仅使用 swagger-play2 模块的 @Api* 注释？

参考：

-Swagger：https ://developers.helloreverb.com/swagger/

-Swagger-core：https ://github.com/wordnik/swagger-core

我正在寻找有关 ServiceStack 中的 Swagger 集成的以下问题的解决方案。

我的 RequestObject 具有必需的属性 ID。我想提供以下路线：

基本上，这应该留下在查询字符串中提供 Id 或作为 ServiceConsumer 的路径的选择。

Swagger UI 正确显示了 2 条路由，但无法对两种方式进行测试，因为 API-Member 属性不允许将其指定为 ParameterType 'path' 或 'query'。

来源：https ://gist.github.com/JohannesFerner/5317496

有什么方法可以提供 API 成员规范，特别是针对相应的 Route，或者将其定义为有效的路径和查询？

像这样：