解析Java代码，自动生成文档工具使用说明

页面布局

1. 左侧为菜单，菜单分为两级，一级表示模块，二级表示接口信息

2. 右侧为接口详细信息，主要包括：模拟测试功能，接口详细信息说明，请求参数说明，响应参数说明，自动一个演示的例子表明接口的使用方式
   如下图（图片拼接左侧菜单可能模糊或重影，凑合看）：

   
   
   

   演示页面布局

页面操作

1. 左侧二级菜单可以双击修改，失去焦点时自动保存

   
   
   

   image.png

2. 左侧一级，二级菜单可以拖拽排序

   
   
   

3. 所有带 “编辑”按钮的地方都可以编辑保存，textarea编辑时可以带回车换行，自动记录你的文本格式

   
   
   
   
   
   

4. 请求参数和响应参数，本身是一个树结构，所有编辑的时候跟普通的编辑树一样操做，包括添加一级数据，添加子数据，修改，删除，保存等等，鼠标移入会有提示，如下图

   
   
   
   
   

   5.如果需要给接口提供默认值，修改参数的默认值后，会自动重构json参数，方便测试

   
   
   

代码使用

1. 在你的controller类上增加注解@Api("这里写模块名称")，这里一个@Api对应页面的一个一级菜单，即模块，模块可以由多个类组成，只需设置每个类的模块名称一样，程序会自动把模块名称一样的class组装成同一模块。