问题标签 [springfox]

我想用 Swagger 和 Spring MVC 记录一个 REST API，

我发现 Spring 3 只能使用 Swagger V1

当我在 @RequestBody 前面添加 @ApiParam 时，不要在数据类型中完全显示。

最后我在 Spring 4 中选择了 Swagger V2

我添加了一些依赖和更改，如下所示。

现在可以在需要时显示任何 API 信息，

1. 但仍然不知道为什么 Spring 3 只能使用 SwaggerV1

2. 以及使用 Swagger V2 时 Spring 3 和 Spring 4 的区别

3. 为什么 Spring 3 不需要 spring-web，但 Spring 4 需要

如果需要任何信息，请告诉我

如果您能提供任何帮助，我将不胜感激。

我在带有 gradle 的 IDEA 14 中使用 springfox 2.2.3 快照版本设置我的项目。我遵循指令2.1.1。摇篮快照。我因无法索引 Maven 存储库并在 IDEA 的日志中看到异常而失败：

org.jetbrains.idea.maven.server.MavenServerIndexerException：java.lang.RuntimeException：java.io.FileNotFoundException：资源nexus-maven-repository-index.properties 不存在

我尝试了两个存储库，但都失败了：

• http://oss.jfrog.org/simple/oss-snapshot-local/io/springfox/
• http://oss.jfrog.org/oss-snapshot-local/io/springfox/

谁能知道如何解决这个问题？

我尝试手动下载依赖项并将它们放在我的本地 .m2 目录中并在 gradlemavenLocal()中设置，maven {url ...}但我的尝试失败了，IDEA 对 Gradle 刷新操作发出警告：

现在我认为也应该为 springfox 包手动添加传递依赖项。但它看起来很丑，我想我不应该这样走。

有谁知道我该怎么做？

我的 jhipster v2.23.1 应用程序使用自定义序列化器和反序列化器进行 JSON 解析，我在JacksonConfiguration. REST API 使用我的自定义映射按预期工作。

但是，自动生成的 swagger 文档中显示的 JSON 不反映自定义映射。我希望 swagger 会自动检测自定义序列化器/反序列化器，但既然它没有，我怎么能大摇大摆地显示我的自定义 JSON 格式而不是它自己检测到的格式？

基于http://springfox.github.io/springfox/docs/current/#configuring-springfox上的 springfox 文档，我实现了接口：

在我的 SwaggerConfiguration bean 中。我可以看到该onApplicationEvent(ObjectMapperConfigured event)方法被调用了两次。映射器第一次将按预期序列化我的对象，第二次则不会。如果我用映射器注册我的模块似乎也没有什么区别。我在这里使用的对象是一个联系人。

如何让 springfox 使用我的自定义序列化程序来构建我的招摇文档？还是我应该完全使用不同的方法？

对于像这样的简单案例，Springfox 无法正确生成 swagger 文档：

GET /api/departments - Gets all department

GET /api/departments?name=IT - Gets a department with name passed as query parameter

这是弹簧控制器：

生成的 swagger 文件仅包含 GET /api/departments 条目，而不是带有查询过滤器的条目的踪迹。

任何解决方法？

招摇配置：

我正在将 Springfox 2.2.2 集成到我的 Spring MVC 项目中，但没有像我想的那样生成 api-docs。下面是一些关于我的配置的信息。

我提供了以下依赖项（连同其他库，如 fastxml、webjar、使用正确版本的 spring 等）

Springfox配置如下：

示例性控制器如下所示：

使用上述设置，当我执行 url: localserver:8080/myApp/swagger-ui 时，几乎没有任何内容可显示，但没有错误消息。

然后，我将在 spring-fox-swagger-ui-2.2.2.jar 中找到的内容添加到 src/main/resources/META-INF（我将其解压缩并粘贴到给定文件夹）。现在，当我转到 localserver:8080/myApp/swagger-ui 时，所有绿色图形都会显示，但没有 api 文档。我注意到在服务器日志中 swagger-ui 会查找 swagger-resources 端点，但它会得到 404。当我浏览服务器日志时，我看到没有创建这样的端点：swagger-resources、v2/api-docs 等。但是，我注意到这些类被过滤为 swagger 注释......有一个 springfox。 META-INF/resources/webjars/springfox-swagger-ui 文件夹中包含 swagger-resorces 端点的 Node.js 文件 - 也许它应该切换到不同的名称？

我不知道如何让它工作......我应该以某种方式声明这些端点还是应该自动创建它们？也许我只是错过了一些小东西，但我最近几天一直在与这个问题作斗争，无法弄清楚应该配置什么才能使其正常工作。

我的项目使用 Spring 4.2.2.RELEASE 和 Spring Security 4.0.3.RELEASE 运行良好。我想升级到最新的 Spring 版本 4.2.3.RELEASE 以利用版本中包含的错误修复。我正在使用 Maven 进行依赖管理，因此我将 POM 调整为如下所示：

父项目 POM：

API POM：

当我尝试使用 maven 运行我的项目时，在运行时出现以下异常：

我注意到 Spring Security 4.0.3.RELEASE 依赖于 Spring 4.2.2.RELEASE （我的旧版本）。这会导致问题吗？

我使用 Spring Boot 和集成的 swagger-ui (springfox-swagger2)，我希望能够选择一次上传多个文件。不幸的是，Swagger UI 似乎不允许这样做，至少不给我的控制器方法。

我的控制器方法签名：

Swagger UI 生成：

但我期待一个类似于这样的用户界面：

一次选择一个文件夹中的所有图片比一次选择一张更方便，例如：

springfox-swagger2 支持这个吗？如果是这样，我需要进行哪些更改？

我正在使用带有 Swagger 2 的 Spring Boot（使用 springfox 进行包装）。

我有一个很大的实体，很多字段在服务器端自动填充，我有一个服务来存储它们。我不想像这样大摇大摆地显示这个实体的所有属性， 我想显示一个自定义 json 来存储这个实体，如果可能的话，我想显示要像这样发送的属性

我的控制器：

.. }

请问有人可以帮助我吗？我有点迷失如何用 Swagger 做到这一点。

对于 spring-mvc，默认的 swagger-ui 路径是 /swagger-ui.html。任何将其更改为不同的路径？生成的代码带有一个配置文件 SwaggerUiConfiguration。无论如何要在这里改变它？

嗨，我的 spring mvc 项目中有几个 REST api，我想为每个服务创建文档并将其存储在文件中，以便与团队共享。我经常阅读 Swagger 或 Springfox 并对其进行配置，我补充说

和配置类：

但 swagger-ui.html 不存在，我有：

那么，如何查看我的 Web 服务器文档并将其保存在文件中？当用户必须使用网络平台时，我想避免在 url 上显示。谢谢