# OpenApiToWordConverter

**Repository Path**: dddddasjdn/open-api-to-word-converter

## Basic Information

- **Project Name**: OpenApiToWordConverter
- **Description**: apifox的OpenApi3.0转word文档
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-11-20
- **Last Updated**: 2025-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenAPI 转 Word 文档工具

这是一个基于 Java 的工具，用于将 OpenAPI 规范文档转换为格式良好的 Word (.docx) 文档。该项目使用 `springdoc-openapi` 提供的 OpenAPI 模型解析 API 定义，并通过 Apache POI 生成 Word 文档。

## 功能特性

- 解析 OpenAPI 3.x 规范文件（YAML 或 JSON 格式）
- 自动生成 Word 文档，包含以下内容：
  - 封面页
  - 目录
  - API 概览
  - 接口详细信息（包括请求方法、路径、参数、响应等）
  - 数据模型（Schema）描述
  - 附录（可扩展）
- 支持代码高亮和格式化 JSON 示例
- 自定义样式（如接口方法颜色区分）

## 使用方法

### 编译构建

使用 Maven 构建项目：

```bash
mvn clean package
```

### 运行工具

执行以下命令将 OpenAPI 文件转换为 Word 文档：

```bash
java -jar open-api-to-word-converter.jar <openapi文件路径> <输出word文件路径>
```

例如：

```bash
java -jar open-api-to-word-converter.jar ./openapi.yaml ./api-document.docx
```

### 主要类说明

- `OpenApiToWordConverter`：核心类，负责整个转换流程
- `ObjectMapper`：用于解析 OpenAPI 文件
- `XWPFDocument`：Apache POI 提供的 Word 文档对象，用于构建输出文档

## 技术栈

- Java 11+
- Maven
- [Apache POI](https://poi.apache.org/)：用于操作 Word 文档
- [OpenAPI Parser](https://github.com/swagger-api/swagger-parser)：用于解析 OpenAPI 规范

## 依赖库

- `com.fasterxml.jackson.core:jackson-databind`
- `org.apache.poi:poi-ooxml`
- `io.swagger.core.v3:swagger-parser`

## 贡献指南

欢迎提交 Pull Request 来改进此工具。请确保遵循项目代码风格，并添加适当的注释和文档。

## 许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。