问题标签 [swagger-2.0]

当我将 Swagger 2.0 API 定义更改推送到 GitHub 存储库时，API Manager/Bluemix 是否提供接口（API、挂钩）来自动更新 API 定义？

如何在我的 Swagger 2.0 定义中为 API Manager 中的“文档和附件”选项卡指定项目？

我开发了一个带有 Swagger 注释的 REST API。我已经能够在一个 swagger-ui 应用程序上显示 api 文档，非常好。

问题：我正在尝试使用 swagger 根据我的注释提供的 url 生成符合此规范的客户端。问题是它似乎不兼容，或者至少，我不知道如何让swagger 编辑器读取我的 url，然后从那时起生成客户端。但是大摇大摆的编辑器向我报告了一些错误...

可以将我的带注释的 swagger api 与 swagger 编辑器集成吗？

谢谢。

我正在用 yaml 写我的招摇定义。假设我有一个看起来像这样的定义。

有没有一种方法可以表明有效负载的 id 属性对于 PUT 操作是必需的，并且对于 POST 操作是可选的（或根本不应该出现）？

我正在使用以下 Maven 依赖项和插件

在beans.xml下面是bean定义如下：

我参考了以下博客

我无法使用博客中提到的抢先体验版本，因为它无法下载。我已将版本更改为 2.0.3-SNAPSHOT，现在我看到 HttpMediaTypeNotAcceptableException 异常。我能够生成 WAR 文件，并且在日志中，当我尝试使用 http://localhost:8080/example/v2/api-docs访问它时，我能够看到使用 Swagger 正确创建的资源组，上面提到的异常被抛出。

请帮忙。

我想使用 Swagger 2.0 来记录 REST API，因为这似乎被广泛用于记录 RET API。

但是，我不确定如何将文档和实现保持在 Sync 中？例如，当我添加一个新 API 时，我必须确保 API 文档中使用的模型（表示响应）应该与 REST 实现中创建的模型相同。同样，文档中给出的资源名称应该与实现中的资源名称匹配。

有没有办法从使用 swagger 2.0 规范生成的文档中只生成资源接口和模型类？

有一些工具（例如 mashape）只支持旧版本的 swagger。是否有任何实用程序可以将 Swagger 版本 2.0 JSON 规范降级到旧的 1.2 版本？

我可以使用一个尽最大努力进行降级并删除旧版本不支持的功能的工具。

我正在尝试使用静态 swagger 文件记录一个 API，该文件可以返回一些 JSON，其中包含一个看起来像这样的数组：

我尝试了几种不同的方法来定义我的规范，使用多态性或显式定义多个示例。这些示例总是最终看起来像：

要不就：

有没有办法在我的 swagger 规范中定义一个示例，以便 swagger-ui 显示的示例有效负载将包含一个数组，其中包含一个类型 A 的示例和一个类型 B 的示例，就像我写的第一个 JSON 一样？

我有一个需要formData和path参数的方法。如何在请求中设置数据？

我正在使用 swagger-js v2。

假设下面的示例需要 3 个参数：

1. ResetPassword是路径参数
2. password是一个formData参数
3. repeat_password是一个formData参数

我正在尝试使用 Swagger 记录 REST API。来自我们 API 的简化 JSON 响应如下所示：

或者

他们对成功 GET 的 Swagger 定义可能如下所示：

或者

在我们的 Swagger 文件中可能有很多这样的重复。是否可以定义这些响应以共享公共部分？即我不想输入或复制/粘贴这部分数十次：

我看不出使用鉴别器字段或使用 $ref 将如何工作。