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

java - Swagger UI 基本认证 Springfox

我正在尝试仅使用 Java 配置将自定义标头添加到 Swagger UI(不更改 html 文件)。我正在使用 springfox,并且不想处理有一个单独的 html 文件来访问 swagger ui。

大摇大摆的 UI 响应

使用此代码,我试图改变

进入

或者

但我做不到。这

一个会变成

我不知道如何解决这个问题。这将是理想的

可以工作,但是 ApiKeyVehicle 只有 --header,我不知道是否有办法改变它。

任何人都可以帮我一把吗?

抱歉一切都这么乱

0 投票
3 回答
5893 浏览

gradle - Springfox swagger - 没有带有 spring boot jersey 和 gradle 的 api-docs

我有一个带有 jersey 和 gradle 的 spring boot 应用程序,我正在尝试使用 springfox 自动生成 API 文档。

我已按照此处的步骤操作:http: //springfox.github.io/springfox/docs/current/

这是我所做的:

  • 构建.gradle:

    /li>
  • 春季启动应用程序:

    /li>
  • 现在的控制器(泽西)

    /li>

当我启动服务器并导航到http://localhost:8080/swagger-ui.html时,我可以看到“绿色”UI 屏幕,其中仅列出了基本错误控制器。我自己的控制器不在那里。

我做错了什么?谢了,兄弟们

0 投票
12 回答
187900 浏览

spring-mvc - 如何配置 Spring Security 以允许无需身份验证即可访问 Swagger URL

我的项目有 Spring Security。主要问题:无法在http://localhost:8080/api/v2/api-docs访问 swagger URL 。它说缺少或无效的授权标头。

浏览器窗口的屏幕截图 我的 pom.xml 有以下条目

招摇配置:

应用配置:

web.xml 条目:

网络安全配置:

0 投票
2 回答
1096 浏览

java - 使用 Swagger/Springfox 和 Spring Boot 将查询参数解组到对象中

我的 REST 服务中有一个搜索端点。我正在使用 Spring Boot,所以我有一个 @RestController 设置,它带有一个基于搜索查询返回搜索结果的方法。这是方法定义:

我希望 SwaggerUI 将 SearchQuery 的字段显示为 ui 中的单独查询参数。它没有;它只显示一个通用的“查询”参数。如果我使用 @RequestBody 注释查询,则用户可以将 json 有效负载添加到正文,但这是一个 GET 请求 - 我希望用户只使用查询参数。

有任何想法吗?

0 投票
0 回答
147 浏览

swagger-ui - 为 @BasePathAwareController 注释控制器生成文档

我发现@RestController正确生成了带有注释的控制器的文档。

但是当我使用@BasePathAwareController注释时,不会生成文档。

你知道这是为什么吗?

0 投票
1 回答
1523 浏览

java - 将 byte[] 与 spring-rest 和 springfox 一起使用

我是 REST API 设计的新手,我有两个关于我正在尝试编写的 API 的问题。

我想创建一个服务,提供 PDF 文件编码,在数据库中创建一个对象。

我当前的服务如下所示:

我的问题是:

  1. 是否“推荐”将 byte[] 与 REST API 一起使用?PS:该服务将被 Web 客户端和工具包使用。
  2. 我尝试使用 springfox 来记录我的 API。UI 工具不允许我提交二进制数据。

我使用了以下注释

生成的 JSON 是:

然而,UI 界面显示 PDF 编码的文本区域,并将任何内容作为字符串提交。(例如,如果我提交值“5”,服务器会收到 [53])。

你知道我在这个级别缺少什么吗?

- 编辑 -

PDF 是在客户端从 HTML 表单生成的。所以它不是一个简单的表单提交。

0 投票
3 回答
16179 浏览

spring-boot - Springfox @RestController 命名

我在使用 Springfox 时遇到了一些小麻烦。我无法为 @RestController 类设置名称。

我正在使用 Spring Boot 和 Swagger2。

以下代码将在 springfox ui 中生成一个名为“rest-status-controller”的控制器。我期望的是“应用程序状态”。还有其他我不知道的配置吗?

0 投票
0 回答
310 浏览

spring - springfox swagger ui为有效资源返回404

我使用 swagger 获得 404 的有效资源请求。Swagger 失败并返回 404,而 Postman 正在返回结果。swagger 失败的参数是 authDtls,我必须在这个参数中传递一个 json,如果我传递 json,那么它会以 404 失败,但在非 json 输入下工作正常。我正在使用 springfox swagger ui 版本 2.5.0

这是swagger或springfox中的错误吗?请建议。

Springfox Json:

弹簧控制器:

0 投票
1 回答
181 浏览

java - SpringFox swagger-ui 集成

我在 swagger-ui 中生成的输出是:

有没有办法让它更详细

deletes (Collection«DocumentKey», optional),updates (Collection«AbstractDocument», optional) 全面分解这些部分?

我的案卷如下所示:

为了添加更多细节,documentKey 和 abstractDocument 都被注释了。

下面是没有任何注释的 DocumentChangeSet 类。

0 投票
1 回答
168 浏览

java - 使用 springfox 创建对象 json

我有一个类 documentKey 当通过 springfox 输出呈现时

这正是我想要的问题是另一个类 DocumentChangeSet 输出

有没有办法让 DocumentKey 树嵌套到删除部分?我知道可以使用注释,但肯定有一些方法可以获取 DocumentKey 类中的注释以显示所需的信息