问题标签 [swagger-2.0]

我正在尝试通过在 Swagger YAML 中描述来创建 REST 服务。

该服务具有三个路径：

• /版本
• /partners/{partnerId}/users/{userId}/sessions
• /partners/{partnerId}/books/{bookId}/

我当前描述这些路径的 YAML 文件如下所示：

在这个 YAML 文件中，参数“partnerId”被声明了两次。

有没有办法制作“子路径”，这样我就不必/partners/{partnerId}两次声明路径的一部分？

我有一个 ASP.NET Web Api 2 应用程序。我在其中添加了 Swashbuckle（Swagger for .NET）。它显示我的端点没有问题，但为了发送请求，我需要将 Authorization 标头附加到该请求。如果我理解正确，我需要修改 index.html 文件（https://github.com/swagger-api/swagger-ui#how-to-use-it）所以我 git 克隆了 Swashbuckle 项目为了修改 index.html 并添加一些标题。

这是在 Swashbuckle 中随请求发送 Authorization 标头的唯一方法吗？

我被困在一些愚蠢的事情上：只有当我提供正确的 api 密钥时，我才想用大摇大摆地显示每条路线的文档。我怎样才能做到这一点？当我尝试加载 UI 时，我可以在哪里配置标题？

我试过了：

但它不会出现在请求标头中。

我正在尝试在本地计算机上my.json使用swagger-ui打开我自己生成的 swagger 规范文件。

所以我下载了最新的标签 v2.1.8-M1 并解压了 zip。然后我进入子文件夹dist并将文件复制my.json到其中。现在我打开了index.html，想一探究竟my.json。问题从这里开始：

如果我输入本地路径，它将始终以包含index.html. 因此我无法打开我的文件。我尝试了以下所有组合但均未成功：

• my.json导致file:///D:/swagger-ui/dist/index.html/my.json
• file:///D:/swagger-ui/dist/my.json导致file:///D:/swagger-ui/dist/index.html/file:///D:/swagger-ui/dist/my.json

我是 Swagger API 的新手，在 ASP.Net 中也是如此，我想知道如何在 UI 上添加新的 HTTP 方法（例如 GET、POST、PUT、DELETE）。它仅包含 6 个默认方法。我想添加另一个 GET 方法。那么，有什么帮助吗？

控制器

我正在使用 Swagger 2.0 生成文档。在我的控制器类中，我有一些操作，例如：

为响应上述操作而生成的 Swagger 文档：

在这里，Swagger 文档没有说响应是Page<Employee>. 如何在 Swagger 的文档中获取泛型数据？

如果我有以下返回类型怎么办？

Swagger 操作参数和模型属性也是如此。

我正忙于了解 swagger.json 规范是如何工作的（在我的例子中是 api.json）。在研究过程中，我可以找到许多关于如何处理 GET 请求的示例，但对于 POST 或其他任何内容都没有。我的迫切需要是实现 POST 部分，但我觉得我需要更好地理解这一点，而不是复制和粘贴代码并依靠反复试验来使其工作。Swagger.io 网站上的内容对初学者不友好。有人可以解释下面的示例代码中发生了什么，特别是在两种情况下的“get：”之后：

请您也可以提供一个简单的 POST 示例。

我正在为 REST API 做一个适配器。我已经为 POST 和 PUT 方法的主体使用了模型模式。@RequestBody Model1 requestBody在适配器上。

现在，我遇到body了需要数组的字段。

Swagger UI正文输入

时间 1) 在 Swagger 加载时，模型启动：

时间 2) 用户编辑：

模型1.groovy

Model2.groovy

我想Model1捕获/保存用户添加到fieldArray类似的元素，{ "field2" : "input2b-userAddition " }. 使用当前代码，我只能获取数组的第一个元素get(0)，我不想创建 Model2 的许多实例，除非用户这么说。

我想到的解决方案是@RequestBody Map requestBody在 Model1.groovy 中使用来获取整个请求并将实际用户输入与模型进行比较。然后添加在模型中未找到但在实际用户输入中找到的字段。我想知道是否有更好的方法来做到这一点？

我是 springfox 和 swagger2 的新手。我一直在尝试将 springfox/swagger2 与我的 Spring Boot 微服务集成以生成 API 文档。

我按照“ http://springfox.github.io/springfox/docs/snapshot/ ”站点中给出的步骤进行操作。但是我没有成功带来api文档页面。

每当我试图点击 URL“ http://localhost:8081/swagger-ui.html ”时，我都会在浏览器“Whitelabel 错误页面”中看到一个通用错误页面。

我不确定在我的应用程序中配置 springfox 时犯了什么错误。

是否可以在 Swagger 2.0 定义中定义将显示在应用程序开发人员页面上的 API 图标？

或者至少可以在 API Manager UI 中设置 API 图标？我找不到任何相关的东西。