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

java - Swagger with Spring Rest:api-docs 不生成 json

我正在尝试将 swagger2 与我的 Spring MVC 集成。但是当我尝试访问http://myhost/myapp/api-docs时,我无法获取 json。你能帮我弄清楚我的代码出了什么问题吗?

我的 Pom.xml(与招摇相关)

我的 web.xml

我的 mvc-dispatcher.xml

SwaggerConfig.java

我的控制器

我不确定我是否在这里遗漏了什么。但是当我尝试访问http://localhost:8080/MyApp/api-docs时,我看不到 json。

如果有人能对此有所了解,我将不胜感激。

谢谢,史密斯

0 投票
3 回答
21285 浏览

java - 如何更改 Springfox Swagger 2.0 的 basePath

我正在运行一项服务,可通过以下方式访问 Swagger UI:

但是,它位于代理后面,例如:

Swagger UI 生成的 URL 如下所示:

而不是以 serviceName 作为后缀的实际 URL。据我所知,这意味着操纵 basePath 属性。根据文档:

swagger API 文档不能再描述不同基本路径上的操作。在 1.2 和更早版本中,每个资源都可以有一个单独的 basePath。在 2.0 中,为整个规范定义了 basePath 等效项(schemes+host+basePath)。

@Api(basePath) 已弃用,它没有说明使用什么以及如何使用它。如何让 Swagger 生成的路径正确显示?

我正在使用Spring Boot、Springfox Swagger和注释。

0 投票
1 回答
673 浏览

spring-mvc - 手动描述 Swagger 输入/输出模型(没有 Java 域类)

我们有一个使用 Spring MVC 构建的现有 REST API。我们现在正在寻找是否可以使用 Swagger 生成内部文档(快速)。

我们的 REST 实现的问题是我们确实使用 Spring MVC 将业务对象转换为 json,但是我们有自定义 json 转换器,基本上从业务对象创建 Jettison json 对象(键/值)。不幸的是,目前没有办法改变这一点。顺便说一句,输入也是如此。它基本上总是一个我们发送给客户端的 Hashmap。

因为我们可以使用 Springfox 生成控制器和它的方法是一个好的开始。但我们也想记录输入/输出。有没有办法使用 Swagger Annotation 手动记录输入/输出模型而不参考 Java 域类?

另一种选择是我们完全编写自己的低级 Swagger 规范或研究其他解决方案。

0 投票
2 回答
1632 浏览

java - 重用复杂的spring-fox swagger注解

我正在使用 spring-fox2@ApiImplicitParam注释使 swagger-ui 显示一个框,用于在请求中包含 Authorization 标头:

这工作正常,但我需要控制器中每个方法的授权标头。复制和粘贴这是代码异味。我可以为此定义某种快捷方式注释吗?是否有不同的方式告诉 swagger-ui 为授权标头创建输入字段?

谢谢!

0 投票
2 回答
36124 浏览

spring - Spring + Springfox + Header 参数

像上面 springfox 一样添加一个@HeaderParam方法参数来获取它,当我查看 swagger-ui 时,它有一个标题字段。这正是我想要的。有没有一种方法可以告诉 springfox 在一组方法中包含此标头参数,而不必在方法本身中包含参数?我们真正要做的是使用标头的 servlet 过滤器,我们希望通过 swagger-ui 轻松设置它。

0 投票
1 回答
2873 浏览

spring-mvc - 将 Swagger 服务器存根添加到现有 Spring 应用程序中

将Swagger Codegen生成的服务器存根插入现有 Spring MVC 应用程序的最佳方法是什么?

我首先尝试使用petstore 存根示例。

我的 Spring 配置使用 Java,如下所示:

WebMvcConfiguration 支持:

应用上下文:

如何将io.swagger.configuration包的配置类部分包含到我现有的应用程序中?

更多细节:

我遇到的问题之一是,如果我指定对 petshop 存根的 maven 依赖项(通过mvn install:install-file ...spring-mvc-j8-async目录运行在本地安装):

然后我的spring应用程序找到了两个AbstractAnnotationConfigDispatcherServletInitializers(一个来自我的应用程序,一个来自我的应用程序io.swagger.configuration.WebApplicationswagger-spring-mvc-server并且无法加载 - 出现以下异常:

注册名为“dispatcher”的 servlet 失败。请检查是否有另一个以相同名称注册的 servlet。

我想另一种表达我的问题的方式是,你如何使用生成的服务器存根swagger-codegen?看起来我不能只依赖开箱即用的 Maven 包......

0 投票
1 回答
12148 浏览

java - 在 Springfox 和 Spring MVC 中配置安全模式和上下文

我有使用 Spring MVC 实现的简单 REST 服务。我决定用 Springfox 和 Swagger 2.0 来描述它们。在我开始添加安全模式和上下文之前,一切似乎都很好。我对某些端点使用 HTTP Basic 身份验证,对其他端点使用基于令牌的身份验证。无论我做什么,我都看不到任何设置 HTTP 基本身份验证凭据或在 Swagger UI 中指定令牌的选项。下面是我的配置。为简单起见,我将这两种模式应用于所有端点。

0 投票
1 回答
77 浏览

spring-4 - Swagger Java 类未正确解析

我正在使用 swagger 为我的 Spring Rest API 项目之一创建 API 文档,但是创建的 swagger.json 文件存在问题。我的超级课程之一没有正确转换。

用于实现招摇的库是springfox。请在下面找到实施细节。

配置 EnableWebMvc EnableSwagger2 ComponentScan

这是导致问题的类

创建的 Json

我试图解决这个问题很长时间,但不知道该怎么做。任何人都可以帮助我吗?

提前致谢。维韦克

0 投票
0 回答
168 浏览

spring - 春天的大摇大摆没有显示路线

这是我的配置文件:

}

和:

这是我有一个简单的控制器:

由于某种原因,网址:

给了我以下内容:

我有很多控制器和方法,为什么没有显示出来?PS - 的

似乎没有返回任何路径\路线,为什么?

0 投票
1 回答
1615 浏览

spring-boot - 使用 Swagger + Spring 的模型模式不应显示 ID

我将 Swagger2 与 Springfox 和 Spring Boot 一起使用。我有一个这样定义的端点:

生成的 API 文档在模型模式中显示idStore从技术上讲,创建StoreJSON 时不应包含id. 我试图弄清楚如何告诉 Swagger/Springfox 忽略id但仅针对此端点。