Api Savior 是做什么的？
- 是一个 IDEA 插件，仅支持 Java 。
- 生成 HTTP 接口文档，格式上支持 markdown、html，目的是取代 Swagger。
- 理论上支持所有 Spring MVC 注解开发的 HTTP 接口，同理也支持
Feign的微服务，另外Dubbo这种纯接口写法也是支持的。 - 同时附带一些相关小能力，如支持导出到 Postman，支持生成 cURL 命令，支持单个数据传输类生成说明文档表格、json 示例。
- 移植并完善了两个插件的功能：Github GenerateAllSetter Pull#66 | Github genSets
与 Swagger 的区别
- 随时修改，随时生成，无需启动项目
- 支持 java doc 注释
- 支持 RPC 接口（即 Dubbo/Feign）
- 生成的文档带有入参/出参示例，更直观
- 多种载体，不局限于网页或文档；比如目前就支持导出到 Postman，后续可以很轻松的实现导出到 Yapi，亦或是类似的平台；我们的目的是，写一次注释，一辈子管用！
为什么这个项目有用？
- 代码总是需要点注释，好记性不如烂笔头；而现在，又多了一个写好注释的好理由！
- 每次写接口文档都觉得在做苦力活，尤其是管理后台的业务，动辄就是好几个表的增删改查，也就意味着起码十几个接口，这完全是可避免的！
- 这个插件并不是是只能生成接口文档，还可以实现更多的偷懒的方式（只要和接口相关的），还有很多等待着我们去发掘！
我该如何开始？
1.安装插件
zip 包安装
从最新的 Release 页下载 zip 包，然后打开 IDEA，进入 Settings --> Plugins --> 小齿轮 --> Install Plugin from Disk
Marketplace 安装
打开 IDEA，进入 Settings --> Plugins，选中 Marketplace，输入 api savior 点击 Install
2.打开一个 Spring MVC 或 Dubbo 项目
建议直接打开我专门准备的示例项目：api-savior-examples
git clone https://github.com/gudqs7-idea-plugins/api-savior-examples3.生成文档
找到一个 Controller 或 RPC 接口类，
如 cn.gudqs.example.docer.restful.user.controller.UserController
在类名上右键，然后点击 Generate Api Interface Doc 即可
文档如下图
4.批量生成文档及更多
直接在项目上右键（或某个目录/某个类/任意多选亦可），然后点击相应的按钮，如下图
假设我点击了 Batch Generate Api Interface Doc，则我会得到一个文件夹，按模块（可自定义，默认是最后两级报名）分子文件夹的 Markdown 接口文档，如下图
5.通过 Search Everywhere 搜索 Api
双击 Shift 进入 Search Everywhere 后切换到 Api，或使用快捷键 Ctrl + \ 或 Ctrl + Alt + N 进入如下图界面。
此时您可通过 url 或接口描述来搜索并跳转到该接口。
为此我单独开了一个项目 search-everywhere-api-idea-plugin，欢迎来 Star！
如果需要，我可以从哪里获得更多帮助？
通过提交 Issue 来获取帮助
欢迎大家提问，欢迎大家一起完善它！
另外，我接入了 IDEA 的错误处理组件，因此当发现插件报错提示时，按照 IDEA 提示，可查看错误信息，并一键上报给我（即自动生成一个 Issue）
通过查看 Wiki 来获取更多说明
通过查看 demo 示例来了解项目实际使用效果
贡献指南
致谢名单
- Github intellij-generateAllSetMethod
- Github genSets
- Github RESTKit
- 感谢 JetBrains OpenSource 为此项目提供的全产品许可证!
