问题标签 [swagger-2.0]

我正在使用swagger-codegen以 Objective C 语言生成客户端 SDK。我的 API 之一是采用布尔参数。参数在Swagger 规范中定义如下：

生成的客户端 SDK 正在检查BOOLvariabe 是否为nil. BOOL是 Objective C 中的原始类型，无法检查nil. 它导致编译错误。

如果我们使用 NSNumber+ (NSNumber *)numberWithBool:(BOOL)value代替 BOOL，则可以解决此问题。如何将booleanswagger 规范映射到NSNumber客户端 SDK？

我在ObjcClientCodegen.java中做了一些更改，例如替换以下行

和

即使我BOOL从defaultIncludesHashSets中languageSpecificPrimitives删除

尽管这个生成的客户端 SDK 使用的是 BOOL 数据类型而不是 NSNumber。

在这方面的任何帮助将不胜感激。

在 JS 中，我们通常在创建凭据时传入凭据，但 Swagger 的文档仅显示了在创建客户端对象后如何执行此操作。

我的 swagger REST API 中有一个 get 调用，需要返回一个 pdf 文件。没有明确的示例/文档说明如何在不导致语法错误的情况下执行此操作。

和

和

都失败了。这甚至可能吗？

我有一个使用嵌入式 tomcat 服务器运行的 spring boot 应用程序。我在将 springfox-swagger 与应用程序集成方面取得了部分成功。如果我执行/v2/api-docs，我可以在 webapp 中查看所有 api 的所有文档。但是，当我尝试从 UI 访问相同的内容时，它不起作用。下面是详细的结果。

- localhost:8080/api/swagger-resources 的输出

- localhost:8080/api/v2/api-docs 的输出

但是当我尝试访问 swagger-ui 时，它不起作用。下面是我调用来访问 swagger-ui 的不同 URL。

下面是我的 SwaggerConfig.java 类

以下是我正在使用的 swagger 依赖项

下面是消息转换器的 webconfig 文件

下面的链接说@EnableWebMvc不应该在 spring-boot webapp 中使用，并且使用注释可能会导致启动 swagger-ui 时出现问题。但是，如果我不使用注释，则网络应用程序不会出现（我在下面粘贴了错误堆栈跟踪）

http://springfox.github.io/springfox/docs/current/#configuring-the-objectmapper

当我不使用@EnableWebMvc注解时出现错误跟踪

我有一种感觉，我错过了一些微不足道的东西。有人可以看看，让我知道我错过了什么。？提前致谢。！！

如果查询参数采用驼峰格式，我将面临问题。

例如：http://localhost:9000/api/hello?personName=test

此格式不适用于 Swagger UI。Swagger 无法获取 camelCase 中定义的任何参数。它显示错误“缺少必需的参数：presonName”。

希望这现在很清楚。

再添加一张有错误的屏幕截图

谢谢

我是 swagger 的新手，我已经看过几个在线文档来实现 Swagger 到我的 webapi 并使用 SwaggerConfig 的一些属性进行自定义。

这是我的要求：-我只需要根据“API_Key”文本框的值在“探索”按钮单击时显示 swagger 文档，该值应与我的 app.config 键匹配。

所以我看到这样实现： -

1. 用户来到我的招摇主页，默认情况下它将有空文档，除了如图所示的标题。
2. 在标题中提供的文本框中输入 API_Key，然后单击浏览。
3. 输入的 API 密钥通过我的 app.config 中的密钥或 SwaggerConfig 中的密钥进行验证。
4. 如果验证显示文档，则将错误消息显示为无效的 API 密钥。

需要建议。

亲切的问候，拉古

我想definitions在查询字符串中使用定义的枚举作为我的参数定义的一部分。

我在definitions我的 Swagger 2.0 规范文件的一部分中定义了 Swagger Enum。

我可以在其他定义中创建对它的引用：

我可以在参数为 时使用schema标签来引用它in: body，但在参数为 时则不行in: query

我尝试删除schema:并进行参考enum:，但无法使其正常工作。

我们使用 Swagger 2.0 作为我们的文档。我们正在以编程方式直接从我们的数据设计文档中创建 swagger 2.0 规范。

我们的模型非常复杂且嵌套。我想了解我们是否可以定义内联定义的嵌套数组对象。

例如：

我们有很多在模型中遇到这种情况的情况，此时定义#ref 不是我们想要考虑的选项。我们需要这个来内联处理。

根据以下帖子：httpsenter code here ://github.com/swagger-api/swagger-editor/issues/603#even t-391465196 看起来它不支持处理内联定义的嵌套数组对象。

由于许多大企业的数据模型非常复杂，我们希望在 swagger 2.0 规范中支持此功能。

有没有想过要添加这个功能。

我有 swagger_jaxrs_2.10 (1.3.6) 工作了很长时间，我想从新的 2.0 swagger 规范中受益。

因此，我的 pom 从

至

当我运行时，尝试访问时出现以下错误myApp/swagger.json

有任何想法吗？

我已经在我的 Web API 应用程序上成功实现了 Swashbuckle/Swagger，但对输出不满意。

我的一种 web api 方法（企业事件记录工具）接受复杂对象值的 JSON 对象。

问题是，当存在可以使用的可接受值的选定列表时，参数被列为字符串对象。我已经设置了默认值，因此如果发送了不正确的内容，我设置为默认值。

我想我可以添加其他返回可接受值的服务调用，但我宁愿不这样做。

我确实在 Swashbuckle 上实现了模式部分来设置一个有效的“示例”对象，但它只列出了可能一百种不同组合中的一种。

我可以给出的问题的最佳示例如下：

SourceSystem 可接受的值类似于“Accounting”或“Payments”或“Portal”。而公司的可接受值可能是“子公司 1”或“合作伙伴 1”。

有什么我可以添加到 Swashbuckle/Swagger 以将其输出到某处的吗？