springfox相关内容

端点按资源 swagger 注释分组?

我正在使用 Spring 进行 REST API 开发.我有一些 API,其中有很多端点.当我打开 swagger ui 时,它看起来很紧凑. 我刚刚阅读了这篇文章,看到我们可以分组基于资源级别的端点. 我只想知道如何通过 Spring 的 swagger 注释来实现这一点.如果有人能用一个例子来描述,我很感激. 而且我只是想知道我们是否可以重新组合(更高级别的分组)我们以上述方 ..
发布时间:2021-11-15 02:00:59 其他开发

每个控制器的 SpringFox Docket 在 Spring Boot 中不起作用

在我的 Spring Boot 应用程序中,我有多个 Rest 控制器,需要分别为每个控制器生成 swagger. 通过在我的 Spring Boot 应用程序类中为每个控制器使用以下 Docket 配置,我可以通过访问/v2/api-docs?group=ai 其中 i = 1 到 n 来下载控制器特定的 swagger但是在 swagger-ui.html 中,当我选择 a1(/v ..
发布时间:2021-11-15 00:52:50 其他开发

Swagger @ApiModelProperty 示例值为 Long 为 null

我将 SpringFox 和 Swagger UI 用于 API 文档. 我有一个 DTO,其中有一个 Long 类型的属性.它没有 99% 的时间被填充,所以我想通过将属性值设置为 null 在文档中演示这个事实.所以我想在示例部分使用这个 JSON {/* ... */“legacyId":空} 我已经试过了 @ApiModelProperty(value = "legacyId", ..
发布时间:2021-11-10 23:07:14 其他开发

Springfox swagger-ui 3.0.0 不调出 swagger-ui.html 页面

我在 Springboot 中使用 springfox swagger-ui,但文件上传按钮未启用分段上传.我尝试升级到 springfox-swagger-ui 3.0.0 但这甚至没有打开 swagger-ui 页面.有没有办法获得文件上传按钮? 我的 API 调用如下所示: @RequestMapping(value = "/foo", method = RequestMethod. ..
发布时间:2021-09-01 20:23:20 其他开发

反向代理背后的 Springfox Swagger UI

我已经使用 Swagger API 文档配置了一个 Spring Boot 应用程序并配置了 Swagger UI. 我还在一个反向代理后面运行我的后端应用程序,该代理将所有请求从 host:port/api 映射到 backend_host:port/,当在我映射的本地主机上运行时localhost:8082/api.在生产中应用了类似的映射. 当我从 localhost:8082/ ..
发布时间:2021-09-01 20:23:17 其他开发

如何用实际示例替换模型架构主体参数

我有 spring-boot/spring-mvc 和 springfox swagger2 集成.我附上了示例屏幕截图.在“body"的参数类型中,我有一个描述元素数据类型的模型模式.字符串,0 等!如何用实际示例替换它,以便我可以“尝试一下".这对我的 API 消费者更有用. 解决方案 不确定你是否找到了这个问题的答案,但我还是会回答这个问题. @ApiModelProperty ..
发布时间:2021-09-01 20:22:18 其他开发

在 swagger-ui 中更改 java.sql.Time 的模型架构

在我的 spring-boot 应用程序中,我使用 swagger2 来记录网络服务. 我使用了一些具有 java.sql.Time 和 java.util.Date 属性的类. 在 swagger-ui 中,它们看起来像这样: 日期: 时间: 我想修改它以显示: "change_date": "YYYY-MM-DD" "change_time": "mm ..
发布时间:2021-09-01 20:22:13 其他开发

如何忽略特定 http 动词(GET、POST、PUT)的 swagger 资源属性

我们实现了 2.6.1 版的 spring fox swagger 2,我想为 HTTP GET METHOD 而不是 POST METHOD 显示资源的特定属性,我还没有找到任何使用 swagger 2 的方法.请帮忙,谢谢. 例如: 班级员工{整数标识;字符串名称;} 请求 URI:GET/api/employee/{id}我应该看到 swagger 请求文档为 {ID:"",姓名 ..
发布时间:2021-09-01 20:22:03 其他开发

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

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

如何更改 Springfox Swagger 2.0 的 basePath

我正在运行一项服务,可在以下位置访问 Swagger UI: http://serviceURL/swagger-ui.html 但是,它是在代理后面的,比如: http://proxyURL/serviceName 由 Swagger UI 生成的 URL 如下所示: http://proxyURL/ 而不是以 serviceName 作为后缀的实际 URL.据我所知,这意味着操作 ..
发布时间:2021-09-01 20:21:32 其他开发

删除 SpringFox SwaggerUI 中的基本错误控制器

有没有办法从 springfox swagger-ui 中删除“基本错误控制器"? 图片: 解决方案 您可以限制请求处理程序选择器仅扫描您项目的包: 返回新的 Docket( DocumentationType.SWAGGER_2).选择().apis(RequestHandlerSelectors.basePackage(“你的包"))... ..
发布时间:2021-09-01 20:21:26 其他开发

Spring 3 和 Spring 4 的 Swagger 版本

我想用 Swagger 和 Spring MVC 记录 REST API, 然后我发现 Spring 3 只能使用 Swagger V1 swagger-springmvc1.0.2 当我在@RequestBody 前面添加@ApiParam 时,在数据类型中不完全显示. 最后我在 Spring 4 中选择了 Swagger V2 我添 ..
发布时间:2021-09-01 20:21:07 其他开发

Springfox-Swagger2 406 不可接受的错误 - Spring 4

嗨,我收到“此请求标识的资源只能生成具有根据请求“接受"标头不可接受的特征的响应"错误,即 Http 406 不可接受. 我正在为 swagger 使用以下依赖项 io.springfoxspringfox-swagger22.0.0 ..
发布时间:2021-09-01 20:20:55 其他开发

Spring Fox Swagger UI 掩码密码

我有一个 Spring Fox Swagger UI,我在其中执行了许多操作,其中之一是发布到 Jira,它需要用户输入他们的用户名和密码. 这个问题是密码没有屏蔽. 公共响应实体createJiraIssue( @RequestParam(value = "jiraProject") @ApiParam(value = ParamConfig.PROJECT_DESC) String ..
发布时间:2021-09-01 20:20:11 其他开发

Springfox - 如果 POJO 未在控制器中使用,是否可以通过注释记录它

正如标题所说,如果控制器方法中没有使用 POJO,是否可以在 swagger 文档中包含它? 我尝试在 POJO 类上使用 @ApiModel 注释,即: @ApiModel("POJO")公共类 Pojo {...} 但是,除非控制器返回 POJO,否则我无法让它出现在生成的 swagger 文档中.有没有办法做到这一点? 顺便说一下,我使用的是 springfox 2.9.2 ..
发布时间:2021-09-01 20:17:44 其他开发

如何让 SpringFox Swagger 将字符串参数渲染为另一种模型类型?

如何使 Swagger 将 String 资源参数记录为完整的类类型? 即我有这个资源声明: @PatchMapping(path="/{id}")公共 ApiResponse补丁(@PathVariable 字符串 id,@RequestBody 字符串 myObjText){ 我希望 myObjText 被记录为具有 MyObject 类型的模型,同时仍然能够在方法主体中获取原始 J ..
发布时间:2021-09-01 20:17:17 其他开发

更新到最新版本后替换@EnableSwagger2

我迁移到最新的 springfox-swagger2 版本 2.10.0 但看起来 @EnableSwagger2 已被弃用. 为了在 Spring Boot 项目中启用 Swagger,我应该使用什么注解?@EnableSwagger2WebMvc? 解决方案 @EnableSwagger2 在 swagger 2.10+ 中被弃用 @EnableSwagger2WebMvc ..
发布时间:2021-09-01 20:15:49 其他开发

Springfox swagger 继承支持

有没有办法在 springfox swagger (2.7.0) 中暴露继承/多态性?我知道 swagger 规范支持 allOf.springfox 支持这个吗?下面是示例域模型. @ApiModel公共抽象类动物{私人字符串名称;}@ApiModel(parent=Animal.class)公共类狗扩展动物{...}@ApiModel(parent=Animal.class)公共类 Cat ..
发布时间:2021-09-01 20:15:46 其他开发