接口导出Excel在swagger上导出后无法打开

最新推荐文章于 2023-05-22 10:43:59 发布

原创最新推荐文章于 2023-05-22 10:43:59 发布 · 808 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java

本文将指导您如何在Swagger中调整配置以实现动态下拉模板的生成，重点在于API接口的描述和文件输出格式的应用。

这个时候我们需要在swagger上修改配置：

@ApiOperation（value=“动态生成下拉模板”，produces=“application/octet-stream”）

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

飞鱼<>

关注关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

【经验篇】记SpringBoot+Swagger下载Excel文件打开错误的问题

光阴迷客的知识库

10-21

3628

背景描述需求描述：实现一个报表查询功能，可以根据查询条件导出Excel文件。技术栈： SpringBoot + Swagger 代码示例 public void exportExcel(UserQuery query, HttpServletResponse response) { // 1. 查询数据 List<UserStageInfo> userStageList = sevice.getUserStageList(query); // 2. 生成Excel Workbook

Swagger转换成Excel文件

xushuanglu_csdn的博客

04-08

2185

swagger转Excel文件

参与评论您还未登录，请先登录后发表或查看评论

导出Excel文档.

12-24

该文件用于在项目过程中导出Excel表格

使用swagger api 下载excel，excel打不开

iuie_sl的博客

03-16

1761

需求今天有个常规的需求，先上传一个文件，然后解析文件填充些属性在下载下来，但是最后使用swagger测试的时候，发现下载的文件打开失败，说文件格式不匹配或者文件内容损坏。通过搜索发现需要在api上面加入这个 @ApiOperation(value="测试",produces="application/octet-stream") @RequestMapping 里面也有produces 和consumes， produces ==>指定返回值类型，不但可以设置返回值类型还可以设定返..

用swagger测试导出excel打不开显示部分内容已损坏

qq_42990567的博客

07-14

5723

用swagger测试导出excel打不开显示部分内容已损坏造成excel打不开的原因是响应头的问题在使用swagger进行测试的时候swagger默认使用的响应头是需在@ApiOperation加上produces="application/octet-stream @ApiOperation(value = "汇总导出",produces="application/octet-stream") 常见的媒体格式类型如下： text/html ： HTML格式 text/plain

如何将在线接口文档通过Excel导出

欢迎来到软件测试jeffky博客！在这里，我们将探讨各种与软件测试相关的主题，包括测试策略、方法、工具、最佳实践和行业趋势。我们的目标是帮助读者提高软件质量，确保用户满意度，并分享在软件测试领域的知识和经验。

09-29

1898

将swagger接口JSON文件转化为Excel格式查看

Go语言gin框架项目：按模板导出excel并在网页端下载,并将此接口完成swagger的配置

pyscl01的博客

05-22

2753

Go语言gin框架项目：按模板导出excel并在网页端下载,并将此接口完成swagger的配置的详细步骤

精选资源

swagger文档离线导出,word、pdf、html

01-19

Swagger 是一个广泛使用的 API 设计和文档工具，它允许开发者以结构化的方式定义 RESTful API，使得服务接口清晰易懂，同时提供了一种交互式的 API 文档系统，方便开发者测试和理解 API 功能。Swagger 文档离线导出...

Springboot+Poi实现excel导入导出+swagger2进行测试

个人博客

03-15

1982

Springboot+Poi实现excel导入导出+swagger2进行测试pom.xml文件配置文件--application.yml配置swagger2--SwaggerConfig导入导出实体类--ExcelData导入导出工具类-- ExcelUtil导入导出方法解释导入导出service层-- 对商城菜单栏表进行导入导出导入导出控制层--ExcelControllerSwagger测试导入导出文件 pom.xml文件 <dependencies> <depende

swagger导出pdf和html

11-14

Swagger 导出配置为了将 Swagger 导出 PDF 和 HTML，需要在 Maven 项目中添加相应的配置。首先，需要在 `pom.xml` 文件中添加以下属性： ```xml <project.build.sourceEncoding>UTF-8 ...

swagger easyExcel导出Excel文件打不开，文件损坏

凡事不敷衍，才能被生活所厚待

05-28

1万+

alibaba/easyexcel文件导出 swagger easyExcel导出Excel文件打不开，文件损坏文件下载打不开，将文件输出到本地发现可以打开，而且swagger下载的文件大小比本地文件大（文件大小不等）所以easyExcel输出文件没有问题 swagger修改解决办法： @ApiOperation(value = "导出清单", notes = "export", produces = "application/octet-stream") response.setC

Swagger下载的Excel打不开，下载的Excel比实际大小更大

be Free & Happy

10-31

1142

有同事使用了我写的ExcelUtil生成Excel并提供下载，使用Swagger进行测试的时候，发现下载的Excel打不开。解决思路如下：首先更改输出流的地址，把Excel生成在本地测试下，发现功能正常，Excel可以打开；检查response有没有正确设置Content-type和Content-disposition，发现也没有什么问题；比较下载下来的Excel和第1步生成的Exc...

springboot 采坑之 swagger-ui.html 导出Excel接口无法打开

qq_33695124的博客

07-02

1362

swagger-ui 测试接口本来很方便的，但是用之导出Excel表格的时候，发下下载的文件就会打不开，目前还没找到根本解决办法，只能是修改接口路径，直接测试，会发现代码正常，导出的Excel也可以正常打开，如果不知道swagger-ui 这个坑的话，可能会浪费很多时间去怀疑代码问题 ...

swagger excel下载提示打不开

fwk19840301的博客

08-15

4134

/** * 主表导出 */ @ApiOperation(value = "主表导出",produces="application/octet-stream") @GetMapping(value = "/supplycontract/Export") public ResultVO<String> supplycontractExpor...

springboot整合easyexcel 导入导出excel案例及文件无法打开

xu812063047的博客

08-25

4504

springboot整合easyexcel 并实现导入导出功能

swagger接口导出excel文件打不开

qq_37185361的博客

04-29

2601

swagger接口导出excel文件打不开：接口添加produces="application/octet-stream" @ApiOperation(value = "列表导出",produces="application/octet-stream")

使用Mybatis_plus生成代码，进行swagger接口测试出现错误

qq_42102911的博客

03-15

1458

1.发现在调用数据库时报错了，但是请求controller层，没有问题错误：Failed to obtain JDBC Connection； nested exception is java.sql.SQLException: The server time… 2.网上找了以下，试了该方法，解决了问题，在url后边加上下边内容。 &useJDBCCompliantTimezoneShift=true&serverTimezone=UTC useJDBCCompliantTimezone

利用swagger组件测试excel下载，打开文件乱码。

最新发布

03-25

### 将 Swagger 生成的 Java 接口文档导出为 Excel 格式要实现将通过 Swagger 生成的 API 文档导出为 Excel 文件的功能，可以按照以下方式设计解决方案： #### 设计思路 1. **获取 Swagger JSON 数据** 使用 Swagger 提供的标准接口 `/v2/api-docs` 来提取完整的 API 定义数据。这些数据通常是以 JSON 格式返回的。 2. **解析 JSON 数据并转换成表格结构** 需要编写逻辑来解析上述 JSON 数据，并将其转化为适合存储到 Excel 表格中的格式。 3. **利用 Open XML 或 Apache POI 库创建 Excel 文件** 可以选择使用 `Apache POI` 或者 `Open XML SDK` 创建 `.xlsx` 文件并将解析后的数据写入其中。 --- #### 实现代码示例以下是基于 Spring Boot 和 Swagger 的具体实现方案： ```java import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import org.apache.poi.ss.usermodel.*; import org.apache.poi.xssf.usermodel.XSSFWorkbook; import java.io.FileOutputStream; import java.io.IOException; import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class SwaggerToExcelExporter { public static void main(String[] args) throws IOException, InterruptedException { String swaggerUrl = "http://localhost:8080/v2/api-docs"; // 替换为实际的Swagger URL HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(swaggerUrl)) .header("Accept", "application/json") .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); ObjectMapper objectMapper = new ObjectMapper(); JsonNode jsonNode = objectMapper.readTree(response.body()); Workbook workbook = new XSSFWorkbook(); // 创建一个新的工作簿 Sheet sheet = workbook.createSheet("API Documentation"); int rowNum = 0; Row headerRow = sheet.createRow(rowNum++); writeHeader(headerRow); // 写入表头 for (JsonNode path : jsonNode.get("paths").fieldNames()) { // 遍历路径节点 for (JsonNode method : jsonNode.get("paths").get(path).fieldNames()) { // 遍历HTTP方法 Row dataRow = sheet.createRow(rowNum++); writeData(dataRow, path.asText(), method.asText(), jsonNode.get("paths").get(path).get(method).get("summary").asText()); // 填充数据 } } try (FileOutputStream outputStream = new FileOutputStream("api_documentation.xlsx")) { workbook.write(outputStream); } finally { workbook.close(); } } private static void writeHeader(Row row) { CellStyle style = row.getSheet().getWorkbook().createCellStyle(); Font font = row.getSheet().getWorkbook().createFont(); font.setBold(true); style.setFont(font); createCell(row, 0, "Path", style); createCell(row, 1, "Method", style); createCell(row, 2, "Summary", style); } private static void writeData(Row row, String path, String method, String summary) { createCell(row, 0, path); createCell(row, 1, method.toUpperCase()); createCell(row, 2, summary != null ? summary : ""); } private static void createCell(Row row, int columnCount, Object value, CellStyle style) { Cell cell = row.createCell(columnCount); if (value instanceof String) { cell.setCellValue((String) value); } else if (value instanceof Integer) { cell.setCellValue((Integer) value); } cell.setCellStyle(style); } private static void createCell(Row row, int columnCount, Object value) { createCell(row, columnCount, value, null); } } ``` --- #### 关键点解释 1. **获取 Swagger JSON 数据** - 上述代码中通过 HTTP 请求访问了默认的 Swagger JSON 路径 `/v2/api-docs`[^2]。 2. **JSON 解析与处理** - 利用了 Jackson 库 (`ObjectMapper`) 对 JSON 进行了解析和遍历操作，从而能够逐条读取 API 的定义信息。 3. **Excel 导出功能** - 使用了 Apache POI 工具包来动态构建 Excel 文件，并填充相应的字段内容（如 Path、Method 和 Summary）。最终保存文件名为 `api_documentation.xlsx`。 4. **安全性考虑** 如果项目中有启用 JWT 认证，则需要在发送请求时附加有效的 Token 头部信息以便成功拉取数据[^3]。 --- ####