# api2form

**Repository Path**: penti/api2form

## Basic Information

- **Project Name**: api2form
- **Description**: 将接口调试工具的api文档中的接口转换成word中的表格
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-05
- **Last Updated**: 2025-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API2FORM - API文档转Word表格工具

![API2FORM Logo](icon/app_icon.png)

**API2FORM** 是一个桌面应用程序，旨在将各种格式的API文档（如OpenAPI/Swagger、Apifox、Postman）快速转换为结构清晰、格式统一的Word（.docx）表格，极大地简化了API文档的整理和归档工作。

---

## 🌟 功能特性

- **多格式支持**: 支持多种主流API文档格式，包括：
  - OpenAPI / Swagger (`.json`)
  - Apifox (`.json`)
  - Postman (`.json`)
- **图形化用户界面**: 提供简洁直观的图形界面，操作简单，无需命令行基础。
- **实时预览**: 加载API文件后，可立即预览接口统计信息。
- **智能解析**: 自动解析API的路径、方法、参数、响应等关键信息。
- **样式可配置**: 支持自定义Word表格样式，满足不同文档规范要求。
- **调试模式**: 内置调试日志开关，方便开发者在需要时启用详细日志进行问题排查。
- **跨平台打包**: 提供 `build.py` 脚本，支持在不同操作系统上进行打包。

## 🛠️ 技术栈

- **图形界面**: [PySide6](https://www.qt.io/qt-for-python)
- **Word文档生成**: [python-docx](https://python-docx.readthedocs.io/)
- **API文档解析**: 
  - `json` (标准库)
  - `PyYAML` (用于YAML格式)
  - `prance` (用于OpenAPI/Swagger的解析和验证)
- **打包工具**: [PyInstaller](https://pyinstaller.org/)

## 🚀 快速开始

### 对于用户

1. **下载**: 前往项目的 [Releases](https://github.com/your-username/API2FORM/releases) 页面下载最新的 `API2FORM.exe` 可执行文件。
2. **运行**: 双击 `API2FORM.exe` 即可启动程序，无需安装任何依赖。

### 对于开发者

1. **克隆仓库**:
   ```bash
   git clone https://github.com/your-username/API2FORM.git
   cd API2FORM
   ```

2. **创建虚拟环境**:
   ```bash
   python -m venv .venv
   # Windows
   .venv\Scripts\activate
   # macOS/Linux
   source .venv/bin/activate
   ```

3. **安装依赖**:
   ```bash
   pip install -r requirements.txt
   ```

4. **运行程序**:
   ```bash
   python src/main.py
   ```

## 📖 使用方法

1. **启动程序**: 打开 `API2FORM.exe` 或运行 `python src/main.py`。
2. **加载文件**: 点击 **“加载API文件”** 按钮，选择您的API文档（`.json` 或 `.yaml` 格式）。
3. **预览信息**: 加载成功后，界面会显示API的统计信息。
4. **开始转换**: 点击 **“转换为Word”** 按钮，选择保存路径和文件名。
5. **完成**: 转换完成后，程序会提示成功，并在指定位置生成 `.docx` 文件。

## 🏗️ 构建和打包

项目提供了自动化脚本来简化打包过程。

- **Windows**: 
  ```batch
  build.bat
  ```
- **跨平台 (Windows, macOS, Linux)**:
  ```bash
  python build.py
  ```

打包成功后，可执行文件将生成在 `dist` 目录下。

## 📝 日志和调试

- **默认关闭**: 正常使用时，程序不会生成任何日志文件。
- **启用调试**: 在程序界面的 **“启用调试日志”** 复选框中打勾，即可在程序运行目录下生成 `log` 文件夹并记录详细日志，方便问题排查。

## 🤝 贡献

欢迎对本项目做出贡献！如果您有任何建议或发现任何问题，请随时提交 [Issues](https://github.com/your-username/API2FORM/issues) 或 [Pull Requests](https://github.com/your-username/API2FORM/pulls)。

1. **Fork** 本仓库
2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开一个 **Pull Request**

## 📄 许可证

本项目采用 [MIT License](LICENSE) 许可证。