问题标签 [swagger-2.0]

我正在使用 Wildfly 9.1、swagger-jaxrs 1.5.3 和 swagger-codegen-maven-plugin 2.1.3

我们尝试将 swagger 定义的 API（带有自己的模型和服务）与我们自己的生成器生成的数据库模型结合起来。我们的生成器已经添加了 swagger 所需的注释，以将其识别为 API 的资源。

我们现在尝试在编译时动态生成由 swagger 定义的模型（swagger-codegen-maven-plugin），只要我们不想使用其他模式的类，它就可以很好地工作。

我遇到的两个问题是：

1. 在编写用于为新 api 生成文件的 swagger 规范时，我无法引用我们的数据库模型定义的对象

2. 如果我现在将这些对象添加到 swagger 模型中以防止出现此问题（通过添加虚拟对象或从现有实体生成 .json） swagger 生成的类显然希望它们位于同一个包中。

我正在寻找一种巧妙的方法来结合这两种方法，而不会失去通过编辑 swagger 规范来开发 API 的机会。

我刚刚开始研究 swagger 如何与 akka-http 一起工作，然后我开始使用名为“Spray-Slick-Swagger Sample”的类型安全激活器示例并开始运行。此代码也可在此处获得。

由于这是一个说明性示例，我猜测并非所有 sbt 的“最佳实践”都被遵循。特别是，我注意到所有用于 swagger 的 Web 资源都已签入到 src/main/resources。

在实际项目中，我希望能够建立对 swagger 版本“xxxx.whatever”的依赖，然后我希望 sbt 的依赖管理工具下载适当的 Web 资源（在 swagger .jar 中），然后我想执行一些代码以某种方式打开依赖的 swagger jar 并将 Web 资源提取到正确的位置（即 src/main/resources）...更好的办法是将这些从 src/ 中排除main/resources 并放入 target/... 某处，以便“干净”操作使自动生成的内容轻松消失。

我猜必须有一个插件或一些众所周知的配方。如果有人能指点我一个，那就太棒了。谢谢 ！

我正在使用SpringFox (Swagger)来记录我的 REST API。Swagger 的一个很好的特性是显示示例模型和数据类型格式。

现在，我将我的 API 配置为以毫秒为单位生成和使用日期，但是当我查看示例 JSON 模型时，日期格式如下："2015-09-21T00:51:32.617Z". 请参阅下面的屏幕截图。是否可以告诉 SpringFox (Swagger) 如何正确格式化日期？

我们正在尝试拥有 Swagger 2.0。基本上，它很好，只是它忽略了 @JsonIdentityInfo 和 @JsonIdentityReference 注释。

导致 Swagger 模式输出：

您可以看到它确实读取了 @JsonProperty 注释，将“sourceDefinition”重命名为“sourceDefinitionName”，但该值应该只是一个字符串。

有人对这种集成的此类问题有任何见解吗？

我正在尝试使用 Swagger 定义一个接受实际文件和描述文件内容的模式对象的 API。这是 Swagger YAML 的一个片段。但是，它不会在 Swagger 编辑器中验证。

Swagger 编辑器引发以下验证错误：

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

我错过了什么吗？或者这不是 Swagger 支持的功能吗？

我正在学习使用 swagger code gen 从 swagger.json 文件生成一堆 csharp 文件。

在 CSharpClientCodeGen.class 中，我注意到 apiPackage 和 modelPackage 的变量会在其中生成 Api 和 Model cs 文件。我想创建一个类似于 apiPackage 和 modelPackage 的新包。

我尝试添加以下代码

然后构建客户端代码，但我没有在其中看到新的包文件夹。

不知道该怎么做。如果您能向我指出如何执行此操作的资源，那就太好了。

谢谢

我正在为其编写 Swagger 2.0 规范的 API 基本上是任何 JSON 值的存储。

我想要一个读取值的路径和一个存储非预定义深度的任何 JSON 值（null、数字、整数、字符串、对象、数组）的路径。

不幸的是，Swagger 2.0 似乎对输入和输出的模式非常严格，并且不允许 JSON Schema 允许的整个模式集。Swagger 编辑器不允许混合值（例如，可以是布尔值或整数的属性）或松散定义的数组（必须严格定义项目的类型）和对象。

所以我正在尝试通过定义MixedValue模式来解决问题：

但是 Swagger Editor 拒绝松散定义的object和array属性。

问题： - 有没有办法解决这个问题？- 它只是 Swagger 编辑器错误还是 Swagger 2.0 规范的强限制？- 有没有更好的方法（最佳实践）来指定我需要什么？- 我的 API 规范是否可以预期 swagger 为某些语言生成的代码存在一些限制？

在记录 API 时，有没有办法提供可能值的列表？像这样的东西：

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

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

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

谢谢

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

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