API Savior：让IntelliJ IDEA成为你的终极API文档生成器

API Savior：让IntelliJ IDEA成为你的终极API文档生成器

【免费下载链接】api-savior[IDEA 接口文档插件] 根据代码注释一键生成接口文档, 支持 Restful/Dubbo. 支持 Swagger 注解, 但不止于此项目地址: https://gitcode.com/gh_mirrors/ap/api-savior

你是否曾经为了维护API文档而加班到深夜？面对十几个甚至几十个接口，每个都要手动编写请求参数、响应示例、错误码说明...这种重复劳动不仅枯燥，还容易出错。更糟糕的是，代码更新了，文档却忘了同步，导致团队协作时频繁出现接口调用失败的情况。

API Savior就是为解决这些问题而生的IntelliJ IDEA插件。它能根据你的Java代码注释一键生成完整的API文档，支持Restful和Dubbo接口，真正实现"写一次注释，一辈子管用"的开发体验。

🔄 从手动维护到智能生成的革命

传统API文档维护通常面临三大痛点：

API Savior的核心价值在于：将文档编写从"事后补充"变为"开发过程中的自然产物"。你只需要像往常一样编写代码注释，剩下的交给插件处理。

通过右键菜单批量生成文档，支持按模块组织

🚀 四大核心场景，全面覆盖开发需求

1. 单个接口快速生成

开发过程中，你只需要在Controller类上右键，选择"Generate Api Interface Doc"，即可为当前类中的所有接口生成文档。

支持快捷键Ctrl+Alt+D快速生成单个类的接口文档

核心源码路径：src/main/java/cn/gudqs7/plugins/savior/action/ 包含了所有文档生成相关的Action类。

2. 批量文档生成与模块化管理

对于大型项目，API Savior支持批量生成功能。你可以选择整个项目、特定包或任意多个类，一次性生成所有接口文档。生成的文档会自动按模块组织：

docs/ ├── 用户模块/ │ ├── 用户接口.md │ └── 用户VIP接口.md ├── 订单模块/ │ ├── 下单接口.md │ └── 订单接口.md └── 支付模块/ └── 支付接口.md

自动按模块组织的文档目录结构

3. 支持多种输出格式

API Savior不仅生成文档，还提供多种实用格式：

• Markdown文档：适合团队协作和版本管理
• HTML文档：可直接部署为在线文档
• Postman导出：一键导入到Postman进行测试
• cURL命令：快速复制接口调用命令

4. RPC接口全面支持

除了传统的Restful接口，API Savior还完美支持Dubbo等RPC接口。无论你的服务采用何种通信方式，都能获得一致的文档体验。

📝 实际应用：从代码到文档的完整流程

步骤1：编写带注释的代码

/** * 用户管理控制器 */ @RestController @RequestMapping("/api/user") public class UserController { /** * 查询用户列表（分页） * @param page 页码，从1开始 * @param size 每页大小 * @return 用户列表 */ @GetMapping("/list") public Result<List<User>> listUsers( @RequestParam(defaultValue = "1") int page, @RequestParam(defaultValue = "20") int size) { // 业务逻辑 } }

步骤2：生成文档

在UserController类上右键 → "Generate Api Interface Doc"，API Savior会自动解析：

• 请求路径：/api/user/list
• 请求方法：GET
• 参数说明：page（页码）、size（每页大小）
• 返回值：Result<List >
• 接口描述：查询用户列表（分页）

步骤3：查看生成的文档

包含完整请求信息、参数示例和返回字段说明的文档

步骤4：自定义配置（可选）

如果需要调整生成规则，可以在项目根目录创建docer-config.properties文件：

# 配置示例 default.ip=127.0.0.1 default.port=8080 default.notUsingRandom=true dir.root=docs/api

配置源码参考：src/main/java/cn/gudqs7/plugins/common/enums/PluginSettingEnum.java 包含了所有可配置项。

🔧 与现有开发工具的无缝集成

与IDE深度集成

API Savior作为IntelliJ IDEA插件，与开发环境完美融合：

• 代码智能提示：在编写注释时提供智能补全
• 快捷键支持：Ctrl+Alt+D快速生成文档
• 右键菜单：直观的操作入口
• 错误报告：集成IDEA错误处理组件，一键上报问题

与测试工具链对接

生成的文档可以直接用于测试工作流：

1. Postman导入：导出为Postman Collection，立即开始接口测试
2. 自动化测试：基于生成的文档编写测试用例
3. API监控：文档中的接口信息可用于API监控配置

与文档系统集成

• Confluence/Markdown：生成的Markdown文档可直接发布
• Swagger UI替代：HTML格式文档可替代Swagger UI
• 团队协作：版本控制的文档便于团队Review

🎯 特色功能详解

智能注释解析

API Savior不仅支持标准的JavaDoc注释，还能理解业务语义：

/** * 用户注册接口 * @param user 用户信息 * @param inviteCode 邀请码（可选） * @return 注册结果 * @apiNote 密码需要加密传输 * @deprecated 请使用/v2/register接口 */

插件能识别@apiNote、@deprecated等扩展标签，生成更丰富的文档内容。

数据类型智能推断

对于复杂的数据类型，API Savior能自动生成示例数据：

public class User { private Long id; // -> 示例：12345 private String name; // -> 示例："张三" private LocalDateTime createTime; // -> 示例："2023-01-01 10:00:00" private List<String> tags; // -> 示例：["VIP", "活跃用户"] }

批量处理与增量更新

• 增量更新：只更新修改过的接口文档
• 批量重命名：支持按规则批量重命名生成的文档
• 模板自定义：支持自定义文档模板

🚀 未来发展方向

API Savior的开发团队持续关注开发者需求，未来计划：

1. 更多格式支持：支持OpenAPI 3.0、GraphQL等格式导出
2. AI智能注释：基于AI自动生成或优化代码注释
3. 团队协作增强：支持文档评审、变更通知等功能
4. 更多IDE支持：扩展到VS Code、Eclipse等开发环境

💡 最佳实践建议

注释编写规范

1. 保持注释简洁明了：用一句话描述接口功能
2. 参数说明要完整：包括类型、是否必填、默认值、示例
3. 返回值要具体：说明成功和失败的返回结构
4. 错误码要明确：列出所有可能的错误码和含义

文档管理策略

1. 按模块组织：利用API Savior的模块化组织功能
2. 版本控制：将生成的文档纳入Git版本管理
3. 定期更新：每次代码变更后重新生成文档
4. 团队规范：建立统一的注释和文档标准

集成到CI/CD流程

# GitHub Actions示例 name: Generate API Docs on: push: branches: [main] jobs: generate-docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Generate API Documentation run: | # 调用API Savior生成文档 # 将文档部署到GitHub Pages

🌟 开始使用API Savior

安装方式

1. Marketplace安装：在IntelliJ IDEA中搜索"API Savior"
2. 手动安装：下载最新版本zip包，通过"Install Plugin from Disk"安装

快速体验

要快速体验API Savior的所有功能，建议克隆示例项目：

git clone https://gitcode.com/gh_mirrors/ap/api-savior-examples

获取帮助

• 提交Issue：遇到问题或有功能建议
• 查看Wiki：详细的入门和进阶教程
• 示例项目：查看实际使用效果

结语

API Savior不仅仅是一个文档生成工具，更是改变开发工作流的革命性产品。它让文档编写从负担变为乐趣，让团队协作从混乱变为有序。在微服务架构日益普及的今天，良好的API文档已经成为项目成功的关键因素之一。

尝试API Savior，你会发现：原来API文档可以如此简单、高效、优雅。告别手动编写文档的烦恼，专注于更有价值的业务逻辑开发，让API Savior成为你开发工具箱中不可或缺的利器。

"好的代码需要注释，好的注释应该自动变成文档"——这就是API Savior的设计哲学。

【免费下载链接】api-savior[IDEA 接口文档插件] 根据代码注释一键生成接口文档, 支持 Restful/Dubbo. 支持 Swagger 注解, 但不止于此项目地址: https://gitcode.com/gh_mirrors/ap/api-savior