入门教程

我该如何开始？

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-examples

3.生成文档

找到一个 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 或接口描述来搜索并跳转到该接口。