问题标签 [swagger-2.0]

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 回答
636 浏览

java - Swagger 验证错误“数据与 'oneOf' 中的任何模式都不匹配”

对于我的 Rest API 路由之一,获取 Swagger 验证错误“数据与“oneOf”中的任何模式都不匹配,我使用了注释,这是我的代码

但是,可以通过使用 POGO 对象而不是 T 来修复此错误,如下所示

根据要求我必须坚持使用 T 实现,请帮助我使用通用返回类型来修复此问题

泰纳克斯

0 投票
3 回答
27847 浏览

swagger - Swagger 2.0 在哪里声明 Basic Auth Schema

如何使用 Swagger 2.0 注释定义基本身份验证并将其显示在 swagger UI 中。

在我拥有的资源中:

我看这里:

https://github.com/swagger-api/swagger-core/wiki/Annotations#authorization-authorizationscope

它说“一旦你声明并配置了你在 API 中支持的授权方案,你就可以使用这些注释来记录资源或特定操作需要哪种授权方案”但我找不到任何关于在哪里声明和配置授权方案。

更新:

我找到了有关如何声明架构的代码,但我仍然没有在 UI 中看到有关身份验证架构的任何信息。我不确定我错过了什么

0 投票
1 回答
12145 浏览

json - 从 Swagger 定义生成示例请求和响应

我想从一个 swagger 定义文件(yaml/json)生成一个示例请求和响应。目的是剔除这些 API。

不幸的是,我没有管理员权限来安装 swagger 编辑器的生成服务器列表中列出的任何服务器框架。我也尝试过使用 soapui(5.x) 和 ready api 来模拟它,但是它们都无法解析定义文件的响应对象中的模式引用 - 例如:

有没有一种简单的方法可以从定义中生成模拟请求和响应?

谢谢,

0 投票
1 回答
3291 浏览

json - swagger-ui 如何在模式数组中形成多个响应

我正在尝试以这种格式形成一个招摇的文档。响应是 200 http 代码上的以下 json。我无法形成如下所示的 json。

到目前为止,我有这个:

但我res2根本看不到块。我只是看到res1

0 投票
1 回答
3471 浏览

yaml - 如何在 Swagger 中指定列

如何在 swagger 编辑器中指定 3 列,以便输出应如下所示:

0 投票
1 回答
3984 浏览

swagger - 在 Swagger 中创建我自己的类型

我有这个 swagger 的 YAML 代码,我需要创建自己的类型(名为 MyOwnType)。

如果我使用“MyOwnType”,则会发生编译错误。

我创建了一个定义“MyOwnType”,我可以在模式中使用:“$ref: '#/definitions/MyOwnType'”。

但是如何在参数类型上使用“MyOwnType”定义?

0 投票
6 回答
40206 浏览

swagger - Swagger UI 上的 CORS 问题

有人可以告诉我为什么会出现这些错误。

我正在尝试在端口 9090 上运行 Swagger UI,在 9000 上运行 Swagger API 文档,并尝试在 UI 中显示文档。

我在 API 文档服务器(端口 9000)上添加了 CORS 过滤器,如下所示。

firefox V33.0 中的 Request 和 Response 标头是

这是我在服务器上设置 CORS 的方式

0 投票
5 回答
3888 浏览

java - Swagger ApiModel 属性访问

我在 REST 端点上对我的请求和响应使用相同的对象。是否可以使用 ApiModelProperty(access = "response") 注释属性,然后使用@ApiImplicitParam(access = "response")注释 其余端点方法, 以便该属性仅显示在响应对象的 swagger 文档中而不是请求一?

0 投票
1 回答
10492 浏览

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

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

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

但是会出现这个错误:

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

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

0 投票
1 回答
1562 浏览

rest - Springfox 没有为 Spring MVC Rest 版本化 API 生成 Swagger 文档

我们正面临着我们的 REST API 版本控制,在阅读了很多关于不同选项(URI 版本控制、mime 类型版本控制)的信息后,我们决定使用后一种方法。

我期待 Springfox 生成以下文档:

v1:

v2:

但是,在 v2 中,我也得到了这个:

它不应该在那里,因为我配置了 v2 Docklet .produces(new HashSet<String>(Arrays.asList(new String[]{"application/vnd.arch.service.v2+json"})))以便它根据版本化的 mime 类型过滤服务。为什么不工作?

这是我们的springfox 配置

这些是REST 控制器