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

spring-mvc - 如何基于http方法隐藏相关端点

此代码片段列出了所有 Spring Boot 健康端点以招摇文档。我只想显示 Http GET 方法。有人对此有任何想法吗?

0 投票
1 回答
180 浏览

spring-mvc - 无法将工厂模式与 Spring-Swagger 集成

我已经按照这个参考使用 ServiceLocatorFactoryBean 实现了工厂模式。

它工作正常。

我正在使用 swagger-springMVC ( SpringFox ),它也可以正常工作。

但是,当我尝试将工厂模式与 swagger 一起使用时,它会抛出异常,

我通过遵循多种资源尝试了所有可能的方式,但无法找到解决方案。谁能帮我解决这个问题?

0 投票
2 回答
8827 浏览

spring - 当我在 Spring MVC 中 EnableSwagger2 时不断出错

我想在我的 Spring MVC 项目中包含 spring fox。但是,当我尝试在我的 SwaggerConfig.java 中启用“EnableSwagger2”注释时,我总是会遇到错误。

我正在使用 springfox-swagger 2.2.2 和 spring-webmvc 的版本,它是 3.2.2.RELEASE

我已经尝试了很多事情,但我的构建仍然给我错误。

我已将映射放在 servlet-context.xml 中:

我还将 servlet-mapping 放在 web.xml 中:

但最后,这些都不起作用,我仍然收到错误:

0 投票
4 回答
21471 浏览

java - 在 Swagger 中记录 Spring 的登录/注销 API

我正在使用Spring Boot用户必须登录的地方开发演示 REST 服务,以便执行某些操作子集。使用该简单配置添加Swagger UI(使用库)后:springfox

我最终得到了Swagger UI页面上列出的所有操作的所有 api。不幸的是,我没有在其中列出登录/注销端点。

问题是无法通过Swagger UI内置表单执行部分操作(我发现它非常好的功能并希望让它工作),因为用户没有登录。有没有解决这个问题的方法?我可以手动定义一些端点Swagger吗?

如果有提交凭据的表单(即登录/注销端点),我可以在使用该安全端点之前执行授权。然后,Swagger用户可以token/sessionid从响应中提取并将其粘贴到通过定义的自定义查询参数中@ApiImplicitParams

您可以在下面找到我的安全配置:

0 投票
2 回答
2133 浏览

java - Swagger2 + Spring REST API 不起作用

我有一个 Spring Rest 控制器和它的 NOT spring boot 应用程序。它只是一个 REST API 项目。我想将 swagger2 集成到我的项目中。我尝试了 Net 和演示中的所有示例,但没有运气。当我尝试执行http://localhost:8085/context/swagger-ui.html时出现 404 错误。请在下面找到我的配置,如果有任何差异,请告诉我。非常感谢任何帮助。

罐子 - 在 /WEB-INF/lib 下

google-collections-1.0.jar springfox-core-2.2.2.jar springfox-schema-2.2.2.jar springfox-spi-2.2.2.jar springfox-spring-web-2.2.2.jar springfox-staticdocs-2.2 .2.jar springfox-swagger-common-2.2.2.jar springfox-swagger-ui-2.2.2.jar springfox-swagger2-2.2.2.jar

我的招摇配置类-

我的springconfig类

根据 springfox-java demo 下面的我的应用程序初始化程序类。我尝试使用和不使用以下课程,但无论哪种方式都不起作用。

我可以在相同的上下文中访问我的其余网址,但不能访问 swagger-ui.html。

请让我知道我在这里缺少什么?

0 投票
1 回答
1232 浏览

java - Springfox 招摇抛出 StackOverflowError

我正在尝试将 springfox-swagger 添加到我的 Spring MVC 项目中。我有以下配置:

但部署后我无法访问任何控制器,1-5 分钟后我得到以下堆栈跟踪:

没有 springfox,我的控制器运行良好。我做错了什么?

0 投票
1 回答
993 浏览

spring - 如何避免一般的 Swagger 警告?

我将在 http://editor.swagger.io/#/中验证我的 swagger (v2) 文档,但我收到了以下警告消息。

{ "generalSwaggerWarnings": [ { "swaggerObject": "#/definitions/Future«object»", "message": "定义已定义但未使用:#/definitions/Future«object»" } ] }

0 投票
2 回答
50331 浏览

java - 大摇大摆的日期字段与日期时间字段

我正在使用 swagger 来测试我的 rest api,我的实体类的属性之一是一个日期字段,我需要 yyyy-mm-dd 格式的日期,但是 swagger 模型架构将此字段显示为日期时间而不是日期字段,因此它提供带有时间和区域的日期。如何将此日期时间转换为日期字段?

我有一个 java 实体类 TimeEntry.java,它的属性之一是 Date,它看起来像这样。

对于此字段,在 swagger UI 模型架构上,字段日期显示为 "date": "2016-01-08T22:34:22.337Z" 但我需要将其作为 "date":"2016-01-08" 。

我尝试了以下方法:

1.

2.尝试遵循此代码(覆盖 OverrideConvertor 类),但找不到 swagger-core 1.3 版本 mvn 存储库。仅提供 1.5 版本https://github.com/swagger-api/swagger-core/wiki/overriding-models

  1. 显然,他们从 1.5 版本中删除了 OverrideConvertor 类 https://groups.google.com/forum/#!topic/swagger-swaggersocket/ChiknyHZiP4

请帮忙。

0 投票
2 回答
1042 浏览

serialization - 如何在序列化期间隐藏字段(但不是反序列化)

在我们的项目(springMVC)Rest API 项目中,我希望只对请求和响应使用一个模型(以避免添加大量代码来将字段从对象复制到对象)

我想用 Swagger 来处理所有的文档,但我遇到了一个小问题。例如假设我有一个模型用户

和一个简单的控制器

现在我想大摇大摆地隐藏反序列化而不是序列化的属性密码(因此它显示为输入但输出)和相反的 Id 字段。

我尝试使用@JsonIgnore 和@JsonProperty,但在swagager-ui 上它要么显示所有内容,要么隐藏所有内容。我无法让它工作。

有人可以告诉我归档我的目标的最佳方式是什么?在使用 swagger 时是否可以使用单个模型进行请求和响应?如果无法使用@JsonIgnore,有没有办法以不同的方式存档?

0 投票
6 回答
37238 浏览

java - 如何生成离线 Swagger API 文档?

我有一个 Spring Boot MVC Java Web 应用程序。我已经能够为 API 文档集成 Springfox。当服务器启动并运行时,我可以直观地看到所有 API。

如何生成 OFFLINE swagger API 文档?注意:我不想使用 asciidoc 或 markdown 文档,但我想在 html 文件中使用相同的 swagger API 用户界面。我希望链接相对于本地目录而不是本地主机服务器链接。谢谢