问题标签 [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 投票
1 回答
460 浏览

inheritance - 大摇大摆的继承问题

我在使用带有招摇的继承时遇到问题。我有以下内容:

当我看到 UI 并单击“试试这个”时,我希望看到 ExtendedErrorModel 的字段。但是,我只看到以下不正确的内容:

如您所见,数据类型似乎正确。

在此处输入图像描述

但是,当您查看 try this 框时,您会注意到两个请求框(而不是一个)并且 ExtendedErrorModel 是一个空白下拉框

在此处输入图像描述

网站:http ://editor.swagger.io/#/

任何建议表示赞赏,谢谢,D

0 投票
1 回答
5226 浏览

swagger - Swagger 属性需要 false 导致错误

我正在尝试使用 Swagger 2.0 定义一个 API。在我的模型中,我有一些具有可选属性的对象,所以我试图插入 Swagger 标签“required:false”。

当我插入“必需”标签时,我在编辑器中收到错误,我不知道为什么..

我的 Swagger 定义是:

这是完美的工作。现在我想指定“消息”参数(例如)是可选的。所以我尝试以下方法:

现在我在 Swagger 编辑器中有一个错误:

错误详情如下:

线路:

有人知道我做错了什么吗?

0 投票
2 回答
9760 浏览

json - Swagger POST Json 正文参数模式 YAML

我正在使用 swagger-api 和 swagger-editor 为路由开发一个 RESTful API。我无法弄清楚为什么我通过正文发送的 JSON 从未到达我的控制器。这是我的 YAML

我正在发送的发布请求的示例。

和回应

如果我将参数“name”设置为不需要,我只会收到一个像这样的空响应 { param1: { path: [ 'paths', '/projects', 'post', 'parameters', '0' ], schema : { name: 'param1', in: 'body', description: 'description', required: false, schema: [Object] }, originalValue: {}, value: {} } } 我不知道为什么因为其他格式例如标题、路径或表单数据工作正常。我总是收到一个空对象。req.swagger.params没有价值。我尝试了几种模式,但即使是最简单的也不起作用。我可以从标题中看出“内容类型”:“应用程序/json”。因此设置了内容类型,架构验证了一个名为“

0 投票
1 回答
2482 浏览

swagger - 是否可以在 Swagger ui 之前添加登录页面?

我需要在 Swagger UI 之前添加一个单独的登录页面,以便从另一台服务器进行身份验证。从这个请求中,我将获得一个密钥,我必须将它添加到来自 swagger UI 的每个请求的标题中。

我正在使用带有 swagger 2.0 的节点服务器和 swagger-tool。

0 投票
1 回答
1161 浏览

typescript - 错误TS2307:找不到模块(但在运行js时可以)

这是场景:

使用 Swagger,我为我的 REST 服务创建了一个 api 规范。然后,我生成 angular typescript 样板文件,用于从 Swagger Editor 工具调用我的服务。

当我生成样板文件时,有多个文件都使用 typescript 内部命名空间,而我的项目的其余部分是 AMD,所以我试图将此编译视为第三方非 AMD 库。当我编译打字稿文件时,我将发送到单个 javascript 文件。

我的项目使用 RequireJS,并且我已经使用 RequireJS 注册了我的单个 javascript 文件,如下所示:

})

在另一个文件中,我有代码:

在我上面的同一个文件中:

它以与 myApi 类似的方式向 RequireJS 注册。打字稿没有找到角度的问题。

当我编译我的项目时,我得到了打字稿

错误 TS2307:无法从尝试导入的文件中找到模块“myApi”。

当我运行实际项目时,正确的 myApi 对象会记录到控制台。

我怎样才能让 Typescript 看到这个模块(或者以其他方式抑制这个错误消息)?

0 投票
1 回答
566 浏览

rest - 如何在 swagger 文档上进行协作?

有没有办法在招摇的文件上进行协作?将 yml 放入 git 中,同时拥有 swagger 编辑器的出色功能?

0 投票
1 回答
109 浏览

java - 如何使用 swagger 编辑器构建生成的服务器项目

使用 maven 3.0.5 版本在 swagger 编辑器中构建生成的服务器项目时出现以下错误。我也使用了 Maven 3.3.9。仍然失败并出现相同的错误。java版本是1.8.0_40。这个构建失败的原因是什么?您可以通过在 swagger 编辑器中为 uber API 生成服务器项目并使用 maven 构建它来轻松重现这一点。

0 投票
1 回答
259 浏览

swagger-ui - Swagger-ui - 无法弄清楚 Petstore 的某些功能是如何运作的

我已下载并浏览到 Swagger-UI dist/index.html 文件,它已加载示例 Petstore API。但是,我无法弄清楚某些功能是如何运作的,因此无法将其带到我自己的定义中。

  1. 示例 Petstore 在右下角显示了一个“VALID {...}”按钮。但是,当我导航到自己的 API 定义时,我看不到这一点。如何启用它?
  2. 当我查看 Swagger-UI 呈现的 petstore API 规范时,http://petstore.swagger.io/v2/swagger.json我无法弄清楚它们是如何插入 Swagger Petstore 描述下方的部分的。

Contact the developer 这是一个带有电子邮件地址和主题行的 mailto 链接

Find out more about Swagger http://swagger.io既没有出现在 petstore json 定义中,也没有出现在我正在使用的定义中。

样品是从哪里提取的?

  1. 当我使用 Swagger 编辑器时,它以不同的方式解释规范 - 最重要的是适当地展示terms of uselicense信息。Swagger-UI 不支持这些属性吗?我是否需要在 Swagger-UI 中启用某些东西才能使它们出现?
0 投票
1 回答
2525 浏览

json - 使用 Swagger 如何在正文中创建动态 json 对象

我需要 swagger 编辑器具有更改正文中模型的功能,并且用户应该能够手动输入值来测试 API。以下示例显示了两个车身模型结构发生变化的车身结构。应根据“类型”值使 Swagger 兼容此更改。

正文:{“类型”:“1”,“位置”:{“纬度”:“4556465.555”,“经度”:“56622225.55”}}

{“类型”:“2”,“imageUrl”:“ http://www.example.com/sample.jpg ”}

0 投票
2 回答
1810 浏览

swagger - swagger - 如何正确设置安全性

两个问题:

  1. 当您定义一个新路由并希望通过要求在标头中设置 api_key 来保护它时,您是通过security在 yaml 文件中指定该路由下的一个部分来做到这一点,还是将它放在下面parameters(或两者中) ? 如果把它放在下面就可以了parameters,那么把它放在下面有什么意义security呢?

  2. yaml 文件可以告诉您某些路由受 api_key 保护,但它没有指定该键的值(据我所知)。这是否意味着我需要编写一些自定义中间件来拦截我的路由并检查密钥的有效性,或者它可以由一个招摇工具自动生成?

谢谢。