问题标签 [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 回答
3296 浏览

java - Swagger UI 无法正常工作 Rest APi

我有一个 Rest Api 项目,我正在尝试使用 swagger 来编写文档和 UI。我能够获取文档,但 UI 没有看到 api 文档并且显示为空白。我已经复制了 webapps/WEB-INF 下 dist 文件夹的内容 我可以使用以下方式访问文档:http://localhost:8080/ml-api-ws/v2/api-docs我试图将 index.html 中的 url 更改为指向此文档,但大摇大摆地拉起空白。

网络应用程序/WEB-INF:

在此处输入图像描述

空白招摇:

在此处输入图像描述 索引.html:

Pom.xml

servlet.xml:

Web.xml:

我还尝试将 api 文档保存在 .json 文件中并使用 swagger-ui 进行探索,但页面没有做任何事情。

谢谢!!

0 投票
1 回答
1904 浏览

rest - 将版本降级到 Spring 3.2.9 时出现 Spring fox 问题

我想知道是否可以在 Spring 3.2.9.RELEASE 上运行 Spring fox。

到目前为止,我所做的是在 Spring.4.1.1 上设置实现,效果很好,我可以看到我的文档。但是,不确定当我在 Spring 3.2.9.RELEASE 上做同样的事情时出了什么问题(我需要 Spring 3.2.9,因为项目不想升级到更高版本)

pom.xml:

错误:

上述错误仅在我使用 Spring-3.2.9 而不是 Spring 4.X 版本时发生。

需要帮助使用 Spring-3.2.9 生成文档

0 投票
2 回答
306 浏览

swagger - Springboot + springfox + swagger2 + swagger-ui

如何访问生成的 swagger-ui.html ?或者 index.html 我似乎在我的项目中找不到这个文件。啊!

0 投票
1 回答
423 浏览

spring-boot - Swagger2 springboot springfox无法重命名api

我尝试使用 @Api 和 @ApiModel 重命名我的 api 引用,但似乎没有任何效果。它总是采用类名。我正在使用 swagger2 + springfox 2.4 + springboot。

0 投票
2 回答
8745 浏览

java - 如何在 Swagger 中更改操作成功的响应状态码?

如图所示,添加操作显示为“响应类(状态 200)”。但是,添加操作已以永远不会返回 200 的方式实现。成功时返回 201。

我的问题是如何将(状态 200)更改为(状态 201)?这部分的代码如下:

谢谢!

在此处输入图像描述

0 投票
1 回答
606 浏览

java - 在 Swagger 自动配置过程中扫描了哪些类?

在 Swagger 文档中,我读到@SwaggerDefinition注释可以放置在 Swagger 自动配置过程中扫描的任何类中。

我将注释放在控制器包内的控制器类中,并将此包设置为base-package使用context:component scan我的dispatcher-servlet.xml. 但是,Swagger UI 页面仍然显示默认标题、联系电子邮件等,这意味着它没有选择我的@SwaggerDefinition.

我该如何解决这个问题?任何指针将不胜感激。有点失去了atm。谢谢!

0 投票
1 回答
308 浏览

java - Swagger - 案卷中的 IncludePatterns 选项不可用

我试图在特定环境中禁用招摇,我可以通过在案卷中执行 .enable(false) 来做到这一点,但 UI 页面仍然加载 SWagger ui 框架并在页面上显示 null。我想完全摆脱它,但包含模式选项似乎不再可用,还有其他选择吗?

0 投票
1 回答
78 浏览

java - 如何以侵入性较小的方式使用 springfox?

我想用来在项目springfox中生成 API 文档。springmvc但是通过使用springfox,我必须在控制器和模型中添加java注解,这是非常具有侵入性的。那么我该怎么做才能以一种侵入性较小的方式使用它呢?或者还有什么框架可以做到这一点?(不知道能不能表达清楚。)

0 投票
0 回答
1245 浏览

maven - Swagger 依赖关系破坏 Spring Boot 应用程序

我正在开发一个简单的 Spring Boot 应用程序。公开一个点来检索应用程序版本。当部署在 Tomcat 服务器上以及作为 Spring Boot 应用程序运行时,该应用程序运行良好。我的问题是当我将 Swagger 依赖项添加到 POM 文件时。我收到以下错误

下面是我的 Spring Boot 应用程序配置

我没有使用 XML 来配置应用程序

我的 MVC Web 配置如下

一个简单的控制器,它读取一些属性并将其作为 JSON 响应发送回

我使用 maven 来构建应用程序。依赖如下

依赖树

0 投票
0 回答
382 浏览

swagger - Springfox / Swagger 没有从库中获取注释

我已将 springfox 与我的 spring-boot 应用程序集成,并且 /swagger-ui.html 正在成功显示我的 REST 端点文档。

但是,我的项目是结构化的,因此 API 模型类位于与其他 REST 端点共享的另一个项目中(在 pom.xml 中引用)。编译我的支持 springfox 的 REST 端点会省略共享库中的 @ApiModel 注释,因为编译器只看到共享库中的字节码,而不是带有注释的源。

(我已经确认将 API 模型源直接复制到我的 REST 项目中确实会生成包含 ApiModel 属性信息的文档)。

我该如何解决这个问题?是否可以从共享库中生成 json / yaml 并将其“导入”到 springfox 生成的 swagger HTML 中?