问题标签 [swagger-editor]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
547 浏览

javascript - Swagger-editor 在本地安装时无法使用本地参考

我是招摇的新手。

我在 Ubuntu 14.04 服务器上安装了 Swagger 两次,当我在任何类型的文档中使用时"Uncaught TypeError: Cannot read property 'map' of undefined",Chrome 和 Firefox 中总是出现相同的错误,包括示例。"TypeError: async is undefined async.map(_.keys(remoteRefs), function (refPtr, callback)"$ref

所有其他功能都很好,只有当我尝试使用任何参考时才会重现问题

  • 我的节点版本:v0.10.38
  • Npm 版本:1.4.28
  • Swagger 版本是最新的
0 投票
1 回答
685 浏览

wcf - 从 SWAGGER-UI 使用 Windows 身份验证调用 WCF

我有一个使用 Windows 身份验证的 WCF REST 服务,配置如下:

我正在尝试使用 SWAGGER-UI(和 SWAGGER 编辑器)来调用此 REST 服务,但是当我调用该服务时,我得到401 Unauthorized正如预期的那样,因为我没有发送我的 Windows 凭据。

如何将我的 Windows 凭据发送到 SWAGGER-UI 或将其作为参数提供,以便每个人都可以传递自己的凭据?

0 投票
1 回答
1775 浏览

swagger - 用于消息传递 API 的 Swagger UI

我想知道以下是否可行。

Swagger几乎是我记录基于消息的 API 所需要的。例如对于命令消息,我想说“命令”而不是“发布”,而不是“路径”,我想使用命令的名称。

规范提到供应商扩展可以使用“ x-”属性,但我 1)没有找到任何如何做到这一点的例子,2)不确定使用这些属性是否有助于我实现目标。

任何人都可以向我指出一些可以帮助我继续前进的资源吗?

0 投票
1 回答
187 浏览

swagger - Swagger Core Jersey 1.X 中的 Swagger 规范

我正在使用带有 Jersey 1 的 Swagger。它在 Swagger 规范 v1.2 中生成规范。大多数工具(例如Editor)都需要规范 v2.0。有没有办法生成规范 v2.0 ?

我实际上想要像bootprint-swagger这样的可打印/静态文档,它也需要规范 v2.0。

0 投票
1 回答
1820 浏览

rest - 除了 HTTP GET 之外的任何东西的 Swagger 规范

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

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

0 投票
1 回答
253 浏览

annotations - 在数组字段请求上添加模型模式捕获元素

我正在为 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 中使用来获取整个请求并将实际用户输入与模型进行比较。然后添加在模型中未找到但在实际用户输入中找到的字段。我想知道是否有更好的方法来做到这一点?

0 投票
3 回答
2231 浏览

swagger - Swagger 注释和 Swagger 规范 2.0

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

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

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

谢谢。

0 投票
1 回答
710 浏览

swagger - 如何传递 1 个或多个 4 个字符串的数组以大摇大摆地请求?

基本上,我想设置招摇来接受这样的请求

我当前的设置有一些问题

这将设置POSTURL 以访问这些项目,如下所示testing[0][city]=burbank&testing[0][state]=ca......

当我想像这样访问它们时city=burbank&state=ca……对于每个城市/州/邮政编码/input_id 对。

更新:

我的新设置正在运行,除了招摇时抛出的错误。它虽然有效!

如果有人能找到比这更好的解决方案(没有错误),请告诉我

0 投票
3 回答
12464 浏览

swagger - 如何在定义中创建某些操作而不是其他操作所需的字段

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

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

0 投票
1 回答
1473 浏览

json - 用描述大摇大摆地转换 Json 响应

我尝试使用 Swagger Editor 指定来自 GET 方法的响应。但是当我查看 Swagger UI 时,没有显示响应 JSON。

我的宣言大摇大摆:

在 Swagger UI 中,写着 Response Class (Status 200) > Model Schema 的框有一个像这样的空 json -> {}