# mydoc

**Repository Path**: verytouch/mydoc

## Basic Information

- **Project Name**: mydoc
- **Description**: idea插件，用于springmvc项目生成接口文档。支持html、markdown、word、postman、curl、idea、curl等，支持直接上传到apifox
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-11-26
- **Last Updated**: 2026-06-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



基于代码结构分析，这是一个 IntelliJ IDEA 插件项目。以下是生成的 README：

---

# MyDoc

[English](./README_EN.md) | 中文

MyDoc 是一款 IntelliJ IDEA 插件，通过右键菜单快速生成 Spring Boot 项目的 API 接口文档。

## 功能特性

### 📄 支持的文档格式

| 格式 | 说明 |
|------|------|
| HTML | 生成静态 HTML 接口文档 |
| Markdown | 生成 Markdown 格式文档 |
| Word | 生成 Word (.docx) 文档 |
| PDF | 生成 PDF 文档 |
| Postman | 生成 Postman 集合（支持一键导入） |
| OpenAPI | 生成 OpenAPI 3.0 规范 (JSON/YAML) |
| ApiFox | 一键同步到 ApiFox 平台 |
| Idea Http Client | 生成 IntelliJ IDEA HTTP Client 脚本 |
| Curl | 生成 cURL 命令 |
| JSON Model | 生成 JSON 示例模型 |
| JSON Schema | 生成 JSON Schema |

### 🔍 快速查找接口

按 `Ctrl + \` 可在IDE自带的搜索面板中快速检索所有接口信息。

### 📝 注释智能提取

自动识别以下注释来源：
- Swagger 注解 (`@Api`, `@ApiOperation` 等)
- JavaDoc 文档注释
- 类名/方法名

## 安装方式

### 方式一：从插件市场安装

1. 打开 IntelliJ IDEA
2. 进入 `Settings` → `Plugins`
3. 搜索 `mydoc`
4. 点击安装并重启 IDE

### 方式二：从本地安装

1. 打包插件：`./gradlew buildPlugin`
2. 进入 `Settings` → `Plugins`
3. 点击 ⚙️ → `Install plugin from disk...`
4. 选择生成的 `.zip` 文件

## 使用方法

### 生成单文件文档

在项目管理器中右键点击 Java 源文件或 controller 文件，选择 `Generate API Doc`，然后选择想要的文档格式。

### 生成当前编辑器文档

在编辑器中打开 Controller 文件，右键选择 `Generate API Doc`。

### 生成项目中所有接口文档

右键点击项目根目录或包目录，选择 `Generate API Doc`。

### 配置插件

1. 进入 `Settings` → `Tools` → `MyDoc Settings`
2. 配置以下选项：

   - **Context Path**: API 基础路径
   - **API Server**: API 服务器地址（用于生成完整请求 URL）
   - **Headers**: 全局请求头（如认证信息）
   - **Template Dir**: 自定义模板目录
   - **Output Dir**: 文档输出目录
   - **Show Example**: 是否显示请求示例
   - **Show Required**: 是否标注必填参数
   - **Show Description**: 是否显示描述信息
   - **Ignore Map**: 是否忽略 Map 类型字段

## 项目结构

```
src/main/java/top/verytouch/vkit/mydoc/
├── action/           # IDEA Actions（右键菜单）
│   ├── HtmlAction.java
│   ├── MarkdownAction.java
│   ├── WordAction.java
│   ├── PdfAction.java
│   └── ...
├── builder/          # 文档构建器
│   ├── ApiBuilder.java
│   ├── DocBuilder.java
│   ├── clipboard/    # 剪贴板输出
│   ├── file/         # 文件输出
│   └── http/        # HTTP上传
├── config/           # 配置管理
├── constant/         # 常量定义
├── model/            # 数据模型
├── search/           # 接口搜索
└── util/             # 工具类
```

## 技术栈

- **IntelliJ SDK**: IDEA 插件开发
- **FreeMarker**: 模板引擎（生成 Word、PDF）
- **Jackson**: JSON 处理
- **HttpClient**: API 上传

## 相关文档

- [IntelliJ Platform SDK](https://www.jetbrains.org/intellij/sdk/docs/)
- [OpenAPI 3.0 规范](https://swagger.io/specification/)
- [ApiFox API](https://apifox.help_docs.coding/)

---

许可证：[MIT](./LICENSE)