问题标签 [swagger]

我正在重写（是的，我知道！）一个主要由 API 驱动的 Rails 应用程序，使用 Intridea 的 Grape 和grape-swagger gem 来启用 Swagger UI 进行文档。

所以我有一个简单的 hello world 应用程序正在运行。似乎可以从 swagger 测试中发现，尽管它目前正在给出 JSON 解析错误（我将在接下来研究）。我想将 swagger UI 放入 Rails 应用程序中，指向 /swagger_doc.json，以便在构建时确保文档在旁边正确构建。

我将 Swagger UI 放在 rails 应用程序的什么位置？公共目录？

我写了一些花哨的代码来玩 Swagger API 过滤：

然后我web.xml用这些行扩展了我的文件：

但这似乎不起作用。每当我调用我的 REST 方法时，调试器中既没有停止，ApiAuthorizationFilterImpl也没有打印行。
我错过了什么吗？

使用swagger-ui，但是我不知道如何在php中构建服务器。为什么响应体不响应“sd”和“s”，如何将swagger-ui与php一起使用？我正在尝试很难，有没有人可以帮助我？

我已经看过这个示例应用程序，并且我有兴趣在 play 2 应用程序上使用 swagger。所以我在我的 Build.scala 中包含了依赖项，就像那个项目一样：

但它给了我未解决的依赖关系。

我也试过：

因为我使用 Play 2.1-RC1 但仍然找不到它。

有谁知道我错在哪里（我想我在上面最后一次尝试的时候有一些错误..）

我刚开始第一次使用 swagger，似乎无法弄清楚如何让实现说明通过 Xml Documention 注释显示任何内容。

我已经搜索了几个小时的文档，但没有看到任何关于如何填充 json 输出中的特定字段的内容。

我希望动态完成此操作，并且不想为此数据创建静态 json 文件是否有关于指定哪些字段以获得特定输出的教程或其他文档。

还有一种方法可以根据输入模型在 UI 输出中的操作方法上显示示例 json 请求，而无需手动显示这些请求

编辑：

我遇到的另一个问题是，如果我有一个标记为 Authorize Swagger UI 的简单 get 方法完全中断，并且当我尝试将 Authorize 标头（我正在使用 Bearer 令牌）添加到 javascript api 中的 headers 选项时，授权令牌永远不会被发送代码如下

当我在我的消息处理程序中收到请求时，authHeader 为空，并且在标头集合中根本不存在，并且承载令牌一直运行良好，直到现在使用 Fiddler 是否在 swagger api 中发生了什么我需要做的事情我错过了我几乎完全按照文档进行操作，上面的功能除了身份验证之外工作正常，我无法弄清楚如何填充实施说明

I'm working on REST Api using JAX-RS and JAXB. I also would like to use Swagger to generate docs for the api. I followed the example here https://github.com/wordnik/swagger-core/wiki/java-jax-rs . So I have added com.wordnik.swagger.jaxrs.listing to init parameters in web.xml as below:

When I tray to access the localhost:9090/rapi/api-docs.json url I get the following error:

I fixed it by adding com.wordnik.swagger.core to my custom JAXBContextProvider as below:

This caused another error:

I have been using jaxb.index files to keep the context aware of the classes with JAXB annotations, however there is no jaxb.index file in swagger package which inludes the Documentation class. Has anyone come across similar issue when integrating Swagger with JAXB and JAX-RS?

我正在使用 Swagger-UI 来浏览我自己的 API，它是用葡萄构建的，并用葡萄招摇自动记录。

我已经用谷歌搜索并尝试了我能找到的每一个建议，但我无法让 POST 工作。这是我的标题：

我只是提出了所有建议。我已经在supportedSubmitMethods 中启用了所有HTTP 方法，并且我已经使用POSTMAN Chrome 扩展测试了API，它运行良好。正确创建用户并返回正确的数据。

然而，我通过招摇的帖子得到的只是服务器报告：

和招摇的反应看起来像这样：

请求网址

响应体

响应代码

响应标头

我还用 POSTMAN 测试了 OPTIONS 响应，如下所示：

我发现在介绍性幻灯片中提到了招摇。但没有别的地方。是不是事情还没有完成？

编辑：显然它在待办事项列表中。

有什么好方法可以自动记录 RestAPI 吗？

在我的项目中，我使用 Maven、Jetty、Swagger、Java 和 Jersey 来创建 REST API。我还使用 Swagger 为我的 API 创建漂亮的文档。

几乎一切都很好，而不是三个问题。一开始 - 这是我的 web.xml

1）如何从listingPath的开头删除api-docs？

我想在路径的开头删除 /api-docs ..

2) 如何从 api 中删除“/api-docs/resources”？我只使用“员工”类，而不是“资源”。

3）如果我输入http://localhost:8080/rest/api-docs/employee我的方法和'/'主 URL 是空的。我可以删除它吗？

我尝试了很多配置。我错过了什么吗？

MultivaluedMap是否可以使用 Swagger 通过 Jersey 中的参数注释来制作 API 文档？

我有一小段代码是这样的：

我想使用 Swagger 和 Swagger UI@ApiParam生成文档数据。JSON

如果我把它放在 formParams@ApiParam之前MultivaluedMap<String, String>它不起作用。Swagger 不能列出任何参数。