问题标签 [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 投票
1 回答
3299 浏览

swagger - Swagger 2 springfox @ApiModel 子类型不起作用

我在Spring Boot中使用swagger2注释。我使用的是 springfox- swagger2 版本 2.2.2

注释中的“示例”属性@ApiModelProperty未被识别。

@ApiModelProperty(name="empName", example="someName")

在 swagger.json 中,它显示为“ empName":"string”而不是“ empName":"someName”。

@ApiModel也无法识别其中的“子类型”属性。

请帮忙!

0 投票
2 回答
3724 浏览

swagger - Springfox Swagger 使用端口 80 为 HTTPS URL 生成请求

我在使用 springfox-swagger2 v2.2.0 时遇到了与 HTTP URL 的请求填充端口 80 相关的问题。

无论如何禁用端口的生成或基于 Spring Profile 以编程方式将端口设置为 443?

生成的卷曲:

curl -X GET --header "接受:应用程序/json" " https://test.com:80/api/users/search "

0 投票
1 回答
126 浏览

spring-mvc - springfox 不返回 api 文档

我正在尝试将 springfox 集成到我现有的 sprint Web 应用程序中我配置了 springfox,Web 应用程序正在正确启动,但没有生成 api 文档

这是springfox配置类

这是bean的创建

以下是控制器

当我尝试获取 api 文档时,它只返回 404。有人可以帮我解决这个问题吗

0 投票
1 回答
1106 浏览

swagger-ui - 如何用实际示例替换模型模式主体参数

我有 spring-boot/spring-mvc 和 springfox swagger2 集成。我附上了示例屏幕截图。在“body”的参数类型中,我有一个描述元素数据类型的模型模式。字符串,0等!如何用实际示例替换它,以便我可以“试用”。这对我的 API 使用者来说会更有用。

在此处输入图像描述

0 投票
3 回答
3297 浏览

java - Swagger 2 接受 xml 而不是 json

我有一个带有 spring boot 的项目,我想使用 swagger2 来记录我的 json web 服务。

我有这个配置:

要阅读文档,我使用此链接:http://localhost:9081/v2/api-docs

在招摇的用户界面中,它工作正常。但是当我直接在浏览器中尝试这个链接时,我有这个错误: 在此处输入图像描述

使用 Firebug,我看到它接受 XML 内容而不是 JSON 内容。 在此处输入图像描述

如何修改招摇配置以接受 JSON 内容?

0 投票
3 回答
2207 浏览

java - 在 swagger-ui 中更改 java.sql.Time 的模型模式

在我的 spring-boot 应用程序中,我使用 swagger2 来记录 Web 服务。

我使用一些具有 java.sql.Time 和 java.util.Date 属性的类。

在 swagger-ui 中,它们看起来像这样:

日期 :在此处输入图像描述

时间 :在此处输入图像描述

我想修改它以显示:

  • “change_date”:“YYYY-MM-DD”

  • “change_time”:“mm:ss”

这是我的课:

我怎样才能做到这一点 ?我没有找到任何注释来设置格式。

0 投票
1 回答
26734 浏览

spring-boot - 使用带有 swagger ui 的 @RequestParam 注释方法

我正在使用Springfox库为 REST 服务生成文档并将其显示在 Swagger UI 中。我按照Springfox 文档中的说明进行操作。

我有一个控制器,它使用查询字符串中的参数,方法映射如下:

然后在 swagger-ui 中生成的映射器显示为:

参数在 UI 中正确显示:在此处输入图像描述

但是当我点击 Try it Out 时,请求的 URL 格式错误:

http://localhost:8080/customcollection/1/data {?startDate,endDate}?startDate=1&endDate=2

如何修复?

0 投票
1 回答
2106 浏览

jodatime - 如何在springfox中用String替换joda.DateTime?

我正在尝试使用 springfox(版本 2.0.2)记录我的 spring(版本 3.2.6)应用程序。
我的模型类有一个 org.joda.time.DateTime 字段。当它在响应模型模式中呈现时,它看起来像这样:

我真的很想
摆脱我的领域中那些无用的细节。
到目前为止,我已经在我的招摇配置类中尝试了这个:


所以我使用 Docket 的 directModelSubstitute 方法将 DateTime 类替换为 String 类,但没有成功。 dateAsOf 字段仍在显示所有这些额外信息。
我还尝试在我的 getter 上为 dataAsOf 字段使用 @ApiOperation(dateType="java.lang.String") ,但它仍然不起作用。

你能帮我弄清楚我错过了什么吗?

0 投票
1 回答
3609 浏览

spring-boot - 从 Swagger UI 测试 API 时 Springfox 404 错误

调查 Springfox 和 Swagger UI,但我面临一个问题。我使用 Spring Boot REST 示例项目作为我的 PoC 的基础。我正在运行 JDK 8,并且该项目利用了 Gradle。

首先,这里是项目的文件内容:

构建.gradle

GreetingController.java

问候语.java

应用程序.java

这是我面临的问题。当我构建并运行应用程序时,我可以成功导航到 Swagger UI 页面 ( http://localhost:8080/swagger-ui.html )。当我展开问候控制器时,我看到了不同的方法并展开“get /greeting{?name}”。Get 部分有以下内容:

当我单击“试用”按钮时,我看到以下内容:

乍一看,出于某种原因,Springfox/Swagger 似乎没有正确替换 {?name} 的占位符。我的问题是,如果这确实是问题,我该如何配置它,以便我可以从 Swagger UI 页面成功测试服务?

0 投票
3 回答
9145 浏览

swagger - Swagger Codegen - GET 的内容类型未在 Spring-MVC 生成

从 swagger.io 编辑器页面下载 Swagger Pet Store (Simple) 并做了一个 mvn jetty:run

在 Chrome 上打开 DevTools 并执行 GET 时,我没有看到设置了标头 Content-Type 字段。

这是在 GET /pets{id}

屏幕截图