问题标签 [springfox]

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 投票
2 回答
2465 浏览

rest - Swagger 模型模式响应:SpringFox 中 LocalDate 的备用标签

我们使用 Swagger 2.x 和 SpringFox 2.0 来记录我们使用 Spring MVC 创建的 REST 服务。

我们有一个带有属性 List<LocalDate> 日期的 REST 响应。

在响应的模型架构中,日期标签显示为“LocalDate”。这不是故意的:我们希望使用 'date' 或 'yyyy-MM-dd' 来代替。

我们有这个类:

这导致了这个模型模式:

在模型架构中,我希望将 LocalDate 设为“日期”或“yyyy-MM-dd”。执行此操作的方法似乎是使用 com.wordnik.swagger.annotations.ApiModelProperty 但这没有任何效果(它正在被拾取,因为当我添加 @ApiModelProperty(hidden=true) 它是隐藏的)。

我创建了一个显示问题的示例休息项目。

任何想法如何在 Swagger 的模型架构中将 LocalDate 更改为“日期”或“yyyy-MM-dd”?

0 投票
1 回答
6543 浏览

java - 如何用 List 等泛型类型表示字段在 swagger-spring-mvc 中用于 swagger-codegen

我正在使用 swagger-spring-mvc 0.9.5 并且在我的响应数据中有这样的字段:

问题的简短版本:如何通过 swagger-codegen 从这个带注释的 Java 到例如 Objective C?

由它生成的招摇 JSON 是:

我的同事正在将其输入 swagger-codegen 以生成 Objective C 类,并且它正在生成无法编译的代码。

因为NSArray(内部< >)不是协议。

swagger 模板文件(mustache)为每个模型创建一个协议。当在数组上指定该协议时,JSONModel 会拾取它以从列表/数组中的数据生成正确的模型。所以在这种情况下,预期的输出是

这将创建一个NSArrayof MAAccountAccount作为对象类型并且MA是 swagger 已经拥有的前缀)。

如果我们手动编辑 swagger JSON 以更改Listarray(如在各种类似情况下建议的那样),输出是正确的,但我们希望避免这个手动步骤。

所以我试图让 swagger-spring-mvc 使用"array"

但后来发现它dataType在 swagger-spring-mvc 0.9.5 中被忽略了,从外观上看,在 springfox 2.0 中它被忽略,除非它是一个完全限定的 Java 类名。

有没有办法通过使用 swagger-spring-mvc/springfox"array"或任何其他方式来实现这一点?

0 投票
5 回答
8152 浏览

spring-boot - springfox(swagger2) 不适用于 GsonHttpMessageConverterConfig

我正在尝试构建的是一个 spring-boot (v1.2.3) 应用程序并使用 SpringFox(swagger2) v2.0.0 公开我的 Rest API

我的 Swagger Spring 配置

我需要使用 gson 将我的 pojo 转换为 json,我是这样做的:

问题是如果使用GsonHttpMessageConverter, swagger v2 会生成错误的 json:

JSON 以 value 为前缀,真正的 JSON 成为转义字符串。

如果不使用它应该是这样的GsonHttpMessageConverter

有没有一种解决方案可以创建一个没有价值和转义的正确的招摇 JSON?

0 投票
2 回答
2191 浏览

spring-boot - springfox/swagger2 与 springboot 应用程序集成

我是 springfox 和 swagger2 的新手。我一直在尝试将 springfox/swagger2 与我的 Spring Boot 微服务集成以生成 API 文档。

我按照“ http://springfox.github.io/springfox/docs/snapshot/ ”站点中给出的步骤进行操作。但是我没有成功带来api文档页面。

每当我试图点击 URL“ http://localhost:8081/swagger-ui.html ”时,我都会在浏览器“Whitelabel 错误页面”中看到一个通用错误页面。

我不确定在我的应用程序中配置 springfox 时犯了什么错误。

0 投票
3 回答
3504 浏览

documentation - SpringFox 日期格式为毫秒

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

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

在此处输入图像描述

0 投票
0 回答
2014 浏览

java - Swagger 不在模型类级别填充@Apimodel 注释

我在 Java rest service.model 类中使用 swagger 不填充@apimodel@apimodelproperty. 当我使用高昂的弹簧 MVC 版本时,它会填充。但是,我收到错误,例如此版本不包含 Documention 配置。如何解决这个问题。swagger spring MVC?

这个 bean 包含在 spring XML 文件中。

控制器 HomeController.java

有助于设置和获取 @Apimodel 和 @Apimodelproperty 注释的模型类不在模型类级别显示

为什么我会面临这个问题?

0 投票
1 回答
3236 浏览

java - 使用 Springfox 在 Spring 应用程序中记录 jax-rs 服务

我想使用 Springfox 记录现有应用程序的 API。我将这些依赖项添加到 pom.xml:

我已将 swagger 包添加到 web.xml 中的球衣包中,以便拾取 Swagger2Controller:

应用程序上下文为服务等指定注释:

配置类如下所示:

启动时有一个堆栈跟踪:

这是集成 Swagger 的最佳方法吗?如果是这样,丢失 bean 的修复方法是什么?还是有更简单的方法?

编辑:

将此添加到 web.xml 消除了堆栈跟踪:

但是对http://localhost:9090/myapp/v2/api-docs的查询会导致 404,即使启动控制台显示:

编辑:

也可以使用 jax-rs 映射 SpringFox URI:

但这并不能满足 SpringFox 需要的完整上下文,因此:

0 投票
2 回答
6913 浏览

java - SpringFox 没有找到 jax-rs 端点

在解决了 Using Springfox to document jax-rs services in a Spring app之后,我现在发现 SpringFox 的 JSON 回复没有显示任何 API:

这是springfox-servlet.xml:

这是在属性文件中:

Swagger 被配置为使用反射 jax-rs 扫描器查找实现类:

这是文档配置:

这是一个带有 api 注释的示例类:

为什么不公开 API?使用 wordnik swagger 库会解决这个问题,还是改进解决方案?

0 投票
8 回答
37301 浏览

swagger-ui - 删除 SpringFox SwaggerUI 中的基本错误控制器

有没有办法可以从 springfox swagger-ui 中删除“基本错误控制器”?

图片:

在此处输入图像描述

0 投票
1 回答
4154 浏览

maven - 如何配置 Gradle 以查找本地 SNAPSHOT 资源?

我正在尝试对springfox项目进行一些工作,该项目已被分解为两个独立的项目:springfox 运行时和一套演示。

为了调查某些配置的行为,我需要更改 中的模块springfox/springfox-petstore,并将其编译为springfox-demos/springfox-java-swagger.

在 .springfox中,我构建并发布springfox-petstore~/.m2/repository/io/springfox/springfox-petstore/2.2.2-SNAPSHOT.

接下来,在springfox-demos我添加mavenLocal()为存储库,并添加springfox-petstore-2.2.2-SNAPSHOTchanging=true依赖项。

当我尝试构建springfox-demos运行时,我收到以下错误:

我已经尝试了各种构建任务的组合,但我似乎无法让 Gradle 满足我使用带有 -SNAPSHOT 工件的本地 maven 存储库的请求。

这是顶级 build.gradle: