问题标签 [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 回答
10492 浏览

yaml - 在 Swagger 中创建复杂类型(定义)

我创建了一个名为Product和另一个名为的定义Text(参见代码)。

我不能使用定义中创建的parameters类型。在定义上,我有一个名为的属性,我希望该属性也是类型。pathsTextProductmessageText

但是会出现这个错误:

Swagger 错误:数据与“anyOf”中的任何模式都不匹配。

如何在类型Text上引用类型Product

0 投票
0 回答
1034 浏览

java - Swagger 可以生成 Java 枚举吗?

我有以下 Swagger 定义,我希望 swagger-codegen 会生成一个 Java Enum 类。我仔细阅读了 swagger 论坛,看起来 swagger-codegen 应该生成正确的 Java 代码。

swagger-codegen 的输出如下:

我期待/想要的是以下内容:

0 投票
1 回答
15360 浏览

api - YAML 语法错误:不完整的显式映射对;错过了一个关键节点

我正在用 YAML 编写招摇规范并得到模糊的错误。我已经映射了我认为正确的路径和定义,但不确定这个错误意味着什么:

YAML 语法错误不完整的显式映射对;在第 66 行第 30 列遗漏了一个关键节点:格式:int64schema:^t

线路:

昂首阔步:

然后在定义中的招摇文件底部:

0 投票
1 回答
252 浏览

rest - 仅查询参数名称不同的路径

我正在使用 swagger 编辑器来记录现有 API,该 API 允许路径支持两个不同的请求,这些请求仅在查询参数名称上有所不同。例如:

http://example.com/WS/Login?UserID=foo&Passoword=bar在这里,我支持对和的请求http://example.com/WS/Login?UserID=foo&Token=dubdu22r8dwjgd767dg

swagger 编辑器没有显示上述 yaml 的任何错误,但它只为第二个路径(具有 UserId 和 Token 查询参数的路径)生成文档,而不是两者。有人可以指出我哪里出错了吗?谢谢。

编辑:

如果我将第二/Login:条路径更改为(例如),/Login1:那么我会在文档中看到两条路径。虽然不是解决方案。

我还想到,我可以指定一个/Login:带有必需参数和UserID可选参数的路径。但是我如何指定必须提供其中一个和必须提供?PasswordTokenUserIDPassword

0 投票
1 回答
131 浏览

swagger - 无需额外嵌套层的 swagger 规范中的模型组合

如果我有以下示例,其中定义通过组合Settings嵌入:Thing

如果我在 editor.swagger.io 中定义一个 POST 方法Thing,它最终会构建如下所示的 JSON:

我想嵌入一个带有组合的模型定义,但没有额外的嵌套属性定义——这可能吗?这是我想要的 JSON 结构Thing

有没有办法做到这一点?

0 投票
1 回答
4036 浏览

swagger - 数据与“oneOf”中的任何模式都不匹配 - 错误

使用大摇大摆的在线编辑器遇到以下错误 数据与“oneOf”中的任何模式都不匹配

错误如下指向第 206 行,该行以“参数”开头

我尝试更改类型:定义下的字符串,仍然没有运气。我很确定我在这里缺少正确的类型值,感谢任何帮助

谢谢

0 投票
7 回答
214121 浏览

swagger - 我如何代表“授权:承载”' 在 Swagger 规范 (swagger.json) 中

我试图传达身份验证/安全方案需要设置如下标头:

这是我基于招摇文档所拥有的:

0 投票
1 回答
7357 浏览

swagger - A deterministic version of a JSON schema object

I am trying to use the Swagger Editor to create a custom JSON/YAML for my API. Basically I want to describe a POST request to an endpoint with Accept and Content-Type headers and POST-data in the form of JSON as in the following template {"document": "Some text paragraph", "documentType": "text/plain"}.

This is my swagger.yml file

Swagger editor's error:

Line 59 is where the definitions start, more specifically, json

What am I doing wrong?

0 投票
1 回答
1173 浏览

swagger - 如何重构此 Swagger API 规范

我有一些端点,其中有一些标准错误响应,例如404、和。我想将这些响应重构为 Swagger 定义,但我无法实现这一点。我尝试了一些技巧,但总是导致解析错误。这是我的 yaml。401403default

/users观察和中的重复响应/games。我如何重构并将它们移动到definitions?

0 投票
1 回答
615 浏览

swagger - 同一文件定义中的参数引用导致 Swagger 错误

我正在尝试在 swagger yaml 文件的定义部分中引用我在多个路径中使用的一些参数,即使文档按预期呈现并且请求已正确创建,但在使用try it out按钮时,我会收到此错误。

实际的 yaml 是这个

其中由单独示例swagger.yaml的前几行组成,定义内部是同一文件夹内的parameters.yaml

我调整了引用,使它们指向同一个文件中的实际定义,而不是另一个文件。如果您将这个 yaml 复制并粘贴到在线编辑器中,您将得到这个确切的错误。