English 🇺🇸

• 是一个 IDEA 插件，仅支持 Java 。
• 生成 HTTP 接口文档，格式上支持 markdown、html，目的是取代 Swagger。
• 理论上支持所有 Spring MVC 注解开发的 HTTP 接口，同理也支持 Feign 的微服务，另外 Dubbo 这种纯接口写法也是支持的。
• 同时附带一些相关小能力，如支持导出到 Postman，支持生成 cURL 命令，支持单个数据传输类生成说明文档表格、json 示例。
• 移植并完善了两个插件的功能：Github GenerateAllSetter Pull#66 | Github genSets

• 随时修改，随时生成，无需启动项目
• 支持 java doc 注释
• 支持 RPC 接口（即 Dubbo/Feign）
• 生成的文档带有入参/出参示例，更直观
• 多种载体，不局限于网页或文档；比如目前就支持导出到 Postman，后续可以很轻松的实现导出到 Yapi，亦或是类似的平台；我们的目的是，写一次注释，一辈子管用！

1. 代码总是需要点注释，好记性不如烂笔头；而现在，又多了一个写好注释的好理由！
2. 每次写接口文档都觉得在做苦力活，尤其是管理后台的业务，动辄就是好几个表的增删改查，也就意味着起码十几个接口，这完全是可避免的！
3. 这个插件并不是是只能生成接口文档，还可以实现更多的偷懒的方式（只要和接口相关的），还有很多等待着我们去发掘！

从最新的 Release 页下载 zip 包，然后打开 IDEA，进入 Settings --> Plugins --> 小齿轮 --> Install Plugin from Disk

打开 IDEA，进入 Settings --> Plugins，选中 Marketplace，输入 api savior 点击 Install

建议直接打开我专门准备的示例项目：api-savior-examples

git clone https://github.com/gudqs7-idea-plugins/api-savior-examples

找到一个 Controller 或 RPC 接口类，
如 cn.gudqs.example.docer.restful.user.controller.UserController
在类名上右键，然后点击 Generate Api Interface Doc 即可

文档如下图

直接在项目上右键（或某个目录/某个类/任意多选亦可），然后点击相应的按钮，如下图

假设我点击了 Batch Generate Api Interface Doc，则我会得到一个文件夹，按模块（可自定义，默认是最后两级报名）分子文件夹的 Markdown 接口文档，如下图

如果需要，你可以通过添加配置文件来修改生成文档时的一些细节。

首先，在项目的任何一个目录下，新建一个docer-config.properties文件。当然我们一般会建议你放在根目录或者放在文档生成的目录。

然后，在该文件中添加你想要修改的配置，就像这样：

default.ip=127.0.0.1
default.notUsingRandom=true

这里列出一些常用的配置项：

完整的配置项写在代码里了，可以阅读PluginSettingEnum，相信你可以很轻松的理解它。

最后，重新生成文档，看看文档内容是不是符合你的配置要求。

双击 Shift 进入 Search Everywhere 后切换到 Api，或使用快捷键 Ctrl + \ 或 Ctrl + Alt + N 进入如下图界面。
此时您可通过 url 或接口描述来搜索并跳转到该接口。

为此我单独开了一个项目 search-everywhere-api-idea-plugin，欢迎来 Star！

点击访问 Github Issue

欢迎大家提问，欢迎大家一起完善它！

另外，我接入了 IDEA 的错误处理组件，因此当发现插件报错提示时，按照 IDEA 提示，可查看错误信息，并一键上报给我（即自动生成一个 Issue）

• 入门教程
• 进阶教程

• 点击查看示例项目的 HTML 格式文档效果
• 点击访问示例项目 Github

贡献指南

• Github intellij-generateAllSetMethod
• Github genSets
• Github RESTKit
• 感谢 JetBrains OpenSource 为此项目提供的全产品许可证!