问题标签 [swagger-ui]

过去几天我一直在试图了解是否应该使用 api blueprint、RAML 或 swagger。

看起来 swagger 拥有最大的社区，但我越看越觉得它在文档方面非常缺乏（我被迫多次查看代码以尝试将其与我当前的项目集成），许多 github 问题和 stackoverflow问题没有答案。

我有可能在这里遗漏了什么吗？我想要的只是一个工具来帮助我编写 API 文档和测试端点。

为什么大摇大摆必须成为服务器逻辑的一部分？如果我在编辑器中创建 swagger 文件，然后直接将它们提供给UI，它会中断..

据我所知，它甚至使服务器稍微慢了一点，并迫使存在许多笨拙地维护的集成：p 我在这里错过了什么？

有没有办法让 Swagger 自己美化 JSON，而不需要被调用的库输出漂亮的 JSON？我似乎找不到任何关于这个主题的东西。

我正在尝试使用 Swagger 来描述我正在构建的 web-api。问题是我无法理解如何描述复杂的 json 对象？

例如，如何描述这个对象：

使用 4.0.31，我的 AppHost 配置方法声明如下：

我的印象是，这会将 swagger-ui 的 url 设置为 ../api/resources 的 https 版本，但是我仍然在 swagger URL 文本框中获得常规的 http 端点，例如：

我们的 Web 服务器位于执行 SSL 卸载（并且需要 SSL）的负载平衡器后面，因此 URL 应该是：

积极的一点是，一旦您修复了端点 url，使用“UseHttpsLinks”实际上可以让 swagger-ui 发挥作用。没有它，它根本不起作用！

我正在通过虚拟文件系统使用替换 index.html作为 hack 覆盖 swagger url 属性——因为在开发、QA 和登台环境中，url 属性指向生产......（不太好）

我已经在我的项目中安装了 swagger-ui_rails 并且 swagger 工作正常，但我需要拦截 ajax 调用以发送带有 ajax 调用的标头，因为我的 api 和 swagger 文档位于 2 个单独的域上。我试着和

但它不起作用，我认为不可能更改 gem 正在进行的调用，对吗？那么我该如何解决这个问题，任何帮助将不胜感激。

我正在使用 swagger 工具来记录我的基于 Jersey 的 REST API（我使用的 swaggerui 是在 2014 年 6 月下载的，不知道这个问题是否已在以后的版本中得到修复，但由于我对其代码进行了大量自定义，所以我如果不花费大量时间再次自定义它，则无法选择下载最新版本）。

到目前为止，直到现在，我所有的传输对象都具有一级深度属性（没有嵌入的 pojo）。但是现在我添加了一些返回更复杂对象（两个深度级别）的休息路径，我发现 SwaggerUI 在嵌入对象时没有扩展 JSON 模型模式。

这是 swagger 文档的重要部分：

嵌入的对象是用户和地址，它们的模型正在正确创建，如 json 响应中所示。

但是当打开 SwaggerUI 时，我只能看到：

但我应该看到类似：

扩展内部属性的代码可能有问题，javascript 控制台没有显示任何错误，所以我认为这是一个错误。

我正在尝试使用 Swagger UI，它说我应该首先编写一个描述 REST api 的确切 api 的 api-doc。问题是我不知道这意味着什么。这份文件是用简单的英文写的吗？或者是否有某种格式可以生成 UI？

谢谢！

我正在使用 Swagger 为基于 jax-rs 的 API 生成文档。在我的一个模型中，我具有以下属性：

但是在 UI 中生成的 JSON 模型如下：

所以显然 XmlElementWrapper 注释没有被解析。如何强制 Swagger 正确嵌套元素？

我有用于 Spring Boot 应用程序的 RESTful API。当我试图找出一个涉及尝试添加自定义媒体类型的单独问题时，我遇到了这个问题。

尝试执行此操作后，HttpMediaTypeNotAcceptable当我尝试查看我的 API 文档时遇到异常。此异常仅在日志中可见（如果我将级别提高到DEBUG）。在我看到的浏览器上406 undefined。这是一个屏幕截图：

我从 Spring Boot 的日志中得到的异常是：

问题的根源在于现有的、可生产的媒体类型被覆盖了。

如果没有上面的代码，列表包含：

• application/hal+json
• application/json;charset=UTF-8
• application/*+json;charset=UTF-8.

通过我的更改，列表仅包含application/hal+json我的自定义媒体类型。所以发生的事情是 Spring 根本找不到兼容的媒体类型，因为 Swagger UIapplication/json在其Accept:标题中包含而http://localhost:8080/api-docs出售application/hal+json（我使用 curl 验证）：

我猜 Swagger UI 可能应该将接受标头设置为application/json,application/hal+json或者使用通配符，例如application/*+json.

我在java中使用swagger。

我正在通过代码中的 requestAttributes 读取一个名为 callerId 的标头。我没有通过注释@HeaderParam 使用标题。

由于这个原因，标题部分没有显示在 swagger UI 中以供试用。

如何使此标题显示在试用表单中。

有什么方法可以在不对标头值进行硬编码的情况下实现这一点。

提前致谢。