问题标签 [swagger-editor]

我在 swagger yaml 中定义对象数组时遇到问题。每次我尝试定义类型时，Swagger 编辑器都会出错：yaml 的数组部分。我定义了它，但它不正确，因为它给出了错误。以下是我试图在 swagger yaml 中定义的 json。

我像这样将这个json定义为swagger yaml，但它给出了一个错误：

谁能建议我如何按照招摇规范在 yaml 中定义这个 json？

我需要定义一个多次使用并更改参数的服务。我需要多次定义它，但每当我第二次定义它时，它会自动覆盖前一个。以下是我如何定义它。这是第一个定义：

这是第二个定义：

是否可以在一个 API 规范中多次出现相同的路径？

大摇大摆地为我的服务编写 API 规范。我使用模型定义（'#/definitions/prototype'）作为POST /prototypes和PATCH /prototypes/:id路由的主体参数。

您如何指定 PATCH 路由仅接受 POST 路由所做的请求正文中的属性子集？例如，我希望PATCH /instances/:id路由只允许修改mobileDeviceId原型属性。

我正在尝试使用 Swagger 和 Node.js 创建一个简单的 hello world 应用程序，当我调用 GET 时打印出“Hello”，但出现错误：TypeError: res.json is not a function。使用 Swagger Editor，我创建了以下 yaml api：

我使用 swagger 编辑器生成了一个 node.js 服务器并创建了一个 hello_world.js 控制器。当我尝试通过调用http://localhost:8081/hello?name=victory使用 Swagger UI 测试代码时，我看到了错误：TypeError: res.json is not a function。这是我的 node.js 代码：

我是 Swagger 和 Node.js 的新手，所以我不确定为什么会出现错误或解决问题的最佳方法。您能给我的任何帮助将不胜感激。

更新：事实证明 res.end(greeting) 有效。谁能解释为什么 res.json 和 res.send 没有？

作为我们持续交付管道的一部分，我将部署 AWS API Gateway API。

最简单的方法是使用Amazon API Gateway Importer，它可以从 Swagger 表示创建或更新 Amazon API Gateway API。

AWS 为Swagger 提供 API 网关扩展。使用这些扩展，您可以在 Swagger 定义中提供请求/响应模板。下面是一个示例 json 片段，其中包含 Swagger 的 API 网关扩展：

由于您需要内联 AWS API Gateway 模板，因此编辑 Swagger 定义很容易出错。

Swagger 网站列出了许多用于从 Swagger 定义生成客户端/服务器存根或从 API 代码生成 Swagger 定义的工具。

我正在寻找类似于Troposphere的工具。我的想法是我可以在 Python 中定义我的 API，然后生成 JSON 或 yaml 文件。好处是我可以分离 AWS API Gateway 请求/响应模板，然后将它们拉入生成的 Swagger 定义。

有谁知道任何有用的工具？

我目前正在寻找一种将 JSON 包装在 Swagger UI 组件中的方法。

在 YAML 中，我的对象声明是：

Swagger UI 生成的输出是（我同意，是正确的）： { "message": "string" }

我想要的是：

我只是通过在 YAML 文件中明确声明包装器找到了一种丑陋的方法。但这非常糟糕，因为当我使用“Swagger Codegen”生成客户端或服务器代码时也会生成它。

restExceptionContainer: restException: properties: message: type: string

如果需要，我可以在 Swagger UI 文件中添加代码！需要您的帮助才能找到位置:)

这是我的输入：

它说：

细节

我究竟做错了什么？

是否有工具可以让我从示例 JSON 生成 Swagger yaml 定义模型？

我会进入并编辑和清理 yaml，但如果有一些东西可以根据大型或复杂的样本 json 对象删除 yaml 的结构，那就太好了。

我正在 Swagger Editor 中编写 OpenAPI 定义。

我的类型定义之一包含一个数组，其中包含与父元素相同类型的子元素。即是这样的：

但是，Swagger 编辑器不会获取children数组中的递归引用，它只是显示为“未定义”元素的数组。

有人知道如何做到这一点吗？

我想记录和测试一个 API，它在http://editor.swagger.io/中使用基于 Cookie 的身份验证。举个简单的例子：如何在下面的 YAML 中编写 /login 操作创建一个 Cookie 并且 Cookie 必须传递给 /showMySecretStuff？